@mojaloop/api-snippets 17.6.0 → 17.6.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (93) hide show
  1. package/CHANGELOG.md +7 -0
  2. package/audit-ci.jsonc +3 -1
  3. package/docs/fspiop-rest-v2.0-ISO20022-openapi3-snippets.yaml +1607 -289
  4. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/AccountIdentification4Choice.yaml +12 -0
  5. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/AccountSchemeName1Choice.yaml +8 -0
  6. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ActiveCurrencyAndAmount.yaml +4 -0
  7. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ActiveOrHistoricCurrencyAndAmount.yaml +4 -0
  8. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/AddressType2Code.yaml +1 -0
  9. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/AddressType3Choice.yaml +8 -0
  10. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/BranchAndFinancialInstitutionIdentification6.yaml +12 -0
  11. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/BranchAndFinancialInstitutionIdentification8.yaml +22 -8
  12. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/BranchData3.yaml +16 -0
  13. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/BranchData5.yaml +28 -6
  14. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/CashAccount40.yaml +29 -0
  15. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/CashAccountType2Choice.yaml +8 -0
  16. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/CategoryPurpose1Choice.yaml +8 -0
  17. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ChargeType3Choice.yaml +12 -1
  18. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Charges16.yaml +14 -0
  19. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ClearingSystemIdentification2Choice.yaml +9 -0
  20. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ClearingSystemMemberIdentification2.yaml +9 -0
  21. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Contact13.yaml +53 -0
  22. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Contact4.yaml +48 -0
  23. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/CountryCode.yaml +3 -0
  24. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/CreditTransferTransaction67.yaml +78 -0
  25. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/CreditTransferTransaction68.yaml +48 -0
  26. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/DateAndPlaceOfBirth1.yaml +16 -0
  27. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/DatePeriod2.yaml +10 -2
  28. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Execute_FIToFICustomerCreditTransferV13.yaml +46 -38
  29. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/FinancialIdentificationSchemeName1Choice.yaml +8 -0
  30. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/FinancialInstitutionIdentification18.yaml +48 -7
  31. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/FinancialInstitutionIdentification23.yaml +48 -7
  32. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/FxRequest_FICreditTransferProposal.yaml +71 -69
  33. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/FxResponse_FICreditTransferConfirmation.yaml +8 -0
  34. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Fxecute_FinancialInstitutionCreditTransferV12.yaml +9 -1
  35. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericAccountIdentification1.yaml +12 -0
  36. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericFinancialIdentification1.yaml +12 -0
  37. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericIdentification3.yaml +9 -0
  38. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericIdentification30.yaml +12 -0
  39. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericOrganisationIdentification1.yaml +12 -0
  40. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericOrganisationIdentification3.yaml +12 -0
  41. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericPersonIdentification1.yaml +12 -0
  42. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericPersonIdentification2.yaml +12 -0
  43. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/GetPartiesError_IdentificationVerificationReportV03.yaml +13 -0
  44. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/GetParties_IdentificationVerificationReportV03.yaml +60 -40
  45. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/GroupHeader120.yaml +19 -0
  46. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/IdentificationAssignment3.yaml +14 -0
  47. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/IdentificationInformation4.yaml +12 -0
  48. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/IdentificationVerificationIndicator.yaml +5 -0
  49. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/InstructionForCreditorAgent3.yaml +10 -0
  50. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/InstructionForNextAgent1.yaml +10 -0
  51. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/LocalInstrument2Choice.yaml +8 -0
  52. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/OrganisationIdentification29.yaml +12 -0
  53. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/OrganisationIdentification39.yaml +12 -0
  54. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/OrganisationIdentificationSchemeName1Choice.yaml +8 -0
  55. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/OtherContact1.yaml +8 -0
  56. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/PacsStatus_FIToFIPaymentStatusReportV15.yaml +16 -65
  57. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Party38Choice.yaml +8 -0
  58. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Party40Choice.yaml +9 -1
  59. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Party52Choice.yaml +9 -1
  60. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/PartyIdentification135.yaml +43 -7
  61. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/PartyIdentification272.yaml +21 -0
  62. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/PaymentIdentification13.yaml +39 -0
  63. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/PaymentTypeInformation28.yaml +24 -0
  64. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/PersonIdentification13.yaml +8 -0
  65. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/PersonIdentification18.yaml +8 -0
  66. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/PersonIdentificationSchemeName1Choice.yaml +8 -0
  67. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ProxyAccountIdentification1.yaml +8 -0
  68. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ProxyAccountType1Choice.yaml +11 -1
  69. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Purpose2Choice.yaml +8 -0
  70. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/RegulatoryAuthority2.yaml +8 -0
  71. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/RegulatoryReporting3.yaml +19 -1
  72. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ServiceLevel8Choice.yaml +9 -0
  73. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/SettlementInstruction15.yaml +8 -1
  74. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/StatusReason6Choice.yaml +8 -0
  75. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/StatusReasonInformation14.yaml +12 -0
  76. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/StructuredRegulatoryReporting3.yaml +32 -2
  77. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/SupplementaryData1.yaml +12 -0
  78. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/SupplementaryDataEnvelope1.yaml +5 -2
  79. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxAmount3.yaml +21 -1
  80. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxAuthorisation1.yaml +8 -0
  81. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxData1.yaml +49 -1
  82. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxParty1.yaml +12 -0
  83. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxParty2.yaml +16 -0
  84. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxPeriod3.yaml +16 -4
  85. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxRecord3.yaml +41 -5
  86. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxRecordDetails3.yaml +8 -0
  87. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/VerificationReason1Choice.yaml +9 -0
  88. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/VerificationReport4.yaml +57 -9
  89. package/fspiop/v2_0_ISO20022/openapi3/openapi.yaml +1 -1
  90. package/lib/fspiop/v2_0_ISO20022/json-schemas.json +19225 -8772
  91. package/lib/fspiop/v2_0_ISO20022/openapi.d.ts +1285 -370
  92. package/lib/fspiop/v2_0_ISO20022/schemas.d.ts +17496 -7191
  93. package/package.json +5 -5
@@ -1,4 +1,4 @@
1
- openapi: 3.0.2
1
+ openapi: 3.1.0
2
2
  info:
3
3
  version: v2.0-iso20022-draft
4
4
  title: Open API for FSP Interoperability (FSPIOP) - the ISO 20022 message version
@@ -1352,8 +1352,22 @@ components:
1352
1352
  account servicer.
1353
1353
  properties:
1354
1354
  IBAN:
1355
+ description: >
1356
+ IBAN
1357
+
1358
+ International Bank Account Number (IBAN) - identifier used
1359
+ internationally by financial institutions to uniquely identify the
1360
+ account of a customer. Further specifications of the format and
1361
+ content of the IBAN can be found in the standard ISO 13616 "Banking
1362
+ and related financial services - International Bank Account Number
1363
+ (IBAN)" version 1997-10-01, or later revisions.
1355
1364
  $ref: "#/components/schemas/IBAN2007Identifier"
1356
1365
  Othr:
1366
+ description: >
1367
+ Other
1368
+
1369
+ Unique identification of an account, as assigned by the account
1370
+ servicer, using an identification scheme.
1357
1371
  $ref: "#/components/schemas/GenericAccountIdentification1"
1358
1372
  oneOf:
1359
1373
  - required:
@@ -1369,8 +1383,16 @@ components:
1369
1383
  Sets of elements to identify a name of the identification scheme.
1370
1384
  properties:
1371
1385
  Cd:
1386
+ description: >
1387
+ Code
1388
+
1389
+ Name of the identification scheme, in a coded form as published in
1390
+ an external list.
1372
1391
  $ref: "#/components/schemas/ExternalAccountIdentification1Code"
1373
1392
  Prtry:
1393
+ description: |
1394
+ Proprietary
1395
+ Name of the identification scheme, in a free text form.
1374
1396
  $ref: "#/components/schemas/Max35Text"
1375
1397
  oneOf:
1376
1398
  - required:
@@ -1389,6 +1411,9 @@ components:
1389
1411
  ActiveCurrencyAndAmount:
1390
1412
  $ref: "#/components/schemas/ActiveCurrencyAndAmount_SimpleType"
1391
1413
  Ccy:
1414
+ description: |
1415
+ Currency
1416
+ Identification of the currency in which the account is held.
1392
1417
  $ref: "#/components/schemas/ActiveCurrencyCode"
1393
1418
  required:
1394
1419
  - ActiveCurrencyAndAmount
@@ -1430,6 +1455,9 @@ components:
1430
1455
  ActiveOrHistoricCurrencyAndAmount:
1431
1456
  $ref: "#/components/schemas/ActiveOrHistoricCurrencyAndAmount_SimpleType"
1432
1457
  Ccy:
1458
+ description: |
1459
+ Currency
1460
+ Identification of the currency in which the account is held.
1433
1461
  $ref: "#/components/schemas/ActiveOrHistoricCurrencyCode"
1434
1462
  required:
1435
1463
  - ActiveOrHistoricCurrencyAndAmount
@@ -1455,6 +1483,7 @@ components:
1455
1483
  AddressType2Code:
1456
1484
  description: |
1457
1485
  AddressType2Code
1486
+
1458
1487
  Specifies the type of address.
1459
1488
  enum:
1460
1489
  - ADDR
@@ -1472,8 +1501,14 @@ components:
1472
1501
  Choice of formats for the type of address.
1473
1502
  properties:
1474
1503
  Cd:
1504
+ description: |
1505
+ Code
1506
+ Type of address expressed as a code.
1475
1507
  $ref: "#/components/schemas/AddressType2Code"
1476
1508
  Prtry:
1509
+ description: |
1510
+ Proprietary
1511
+ Type of address expressed as a proprietary code.
1477
1512
  $ref: "#/components/schemas/GenericIdentification30"
1478
1513
  oneOf:
1479
1514
  - required:
@@ -1525,8 +1560,22 @@ components:
1525
1560
  branch of a financial institution.
1526
1561
  properties:
1527
1562
  FinInstnId:
1563
+ description: >
1564
+ FinancialInstitutionIdentification
1565
+
1566
+ Unique and unambiguous identification of a financial institution, as
1567
+ assigned under an internationally recognised or proprietary
1568
+ identification scheme.
1528
1569
  $ref: "#/components/schemas/FinancialInstitutionIdentification18"
1529
1570
  BrnchId:
1571
+ description: >
1572
+ BranchIdentification
1573
+
1574
+ Definition: Identifies a specific branch of a financial institution.
1575
+
1576
+ Usage: This component should be used in case the identification
1577
+ information in the financial institution component does not provide
1578
+ identification up to branch level.
1530
1579
  $ref: "#/components/schemas/BranchData3"
1531
1580
  required:
1532
1581
  - FinInstnId
@@ -1555,23 +1604,37 @@ components:
1555
1604
  branch of a financial institution.
1556
1605
  properties:
1557
1606
  FinInstnId:
1607
+ description: >
1608
+ FinancialInstitutionIdentification
1609
+
1610
+ Unique and unambiguous identification of a financial institution or
1611
+ a branch of a financial institution.
1558
1612
  $ref: "#/components/schemas/FinancialInstitutionIdentification23"
1559
1613
  BrnchId:
1614
+ description: |
1615
+ BranchIdentification
1616
+
1617
+ Identifies a specific branch of a financial institution.
1560
1618
  $ref: "#/components/schemas/BranchData5"
1561
1619
  required:
1562
1620
  - FinInstnId
1563
1621
  example:
1564
1622
  FinInstnId:
1565
- BICFI: BUKBGB22
1623
+ BICFI: J5BMVH7D
1566
1624
  BrnchId:
1567
- Id: 12345
1568
- Nm: Oxford Street Branch
1625
+ Id: 123
1626
+ Nm: Name
1569
1627
  PstlAdr:
1570
- Ctry: GB
1571
- AdrLine:
1572
- - 1 Oxford Street
1573
- - London
1574
- - UK
1628
+ AdrTp: ADDR
1629
+ Dept: Department
1630
+ SubDept: Sub department
1631
+ StrtNm: Street name
1632
+ BldgNb: Building number
1633
+ PstCd: Post code
1634
+ TwnNm: Town name
1635
+ CtrySubDvsn: Country subdivision
1636
+ Ctry: Country
1637
+ AdrLine: Address line
1575
1638
  BranchData3:
1576
1639
  title: BranchData3
1577
1640
  type: object
@@ -1580,12 +1643,32 @@ components:
1580
1643
  institution.
1581
1644
  properties:
1582
1645
  Id:
1646
+ description: >
1647
+ Identification
1648
+
1649
+ Unique and unambiguous identification of a branch of a financial
1650
+ institution.
1583
1651
  $ref: "#/components/schemas/Max35Text"
1584
1652
  LEI:
1653
+ description: >
1654
+ Legal Entity Identifier
1655
+
1656
+ Legal entity identification for the branch of the financial
1657
+ institution.
1585
1658
  $ref: "#/components/schemas/LEIIdentifier"
1586
1659
  Nm:
1660
+ description: >
1661
+ Name
1662
+
1663
+ Name by which an agent is known and which is usually used to
1664
+ identify that agent.
1587
1665
  $ref: "#/components/schemas/Max140Text"
1588
1666
  PstlAdr:
1667
+ description: >
1668
+ Postal Address
1669
+
1670
+ Information that locates and identifies a specific address, as
1671
+ defined by postal services.
1589
1672
  $ref: "#/components/schemas/PostalAddress24"
1590
1673
  example:
1591
1674
  Id: 123
@@ -1609,22 +1692,48 @@ components:
1609
1692
  type: object
1610
1693
  properties:
1611
1694
  Id:
1695
+ description: >
1696
+ Identification
1697
+
1698
+ Unique and unambiguous identification of a branch of a financial
1699
+ institution.
1612
1700
  $ref: "#/components/schemas/Max35Text"
1613
1701
  LEI:
1702
+ description: >
1703
+ LEI
1704
+
1705
+ Legal entity identification for the branch of the financial
1706
+ institution.
1614
1707
  $ref: "#/components/schemas/LEIIdentifier"
1615
1708
  Nm:
1709
+ description: >
1710
+ Name
1711
+
1712
+ Name by which an agent is known and which is usually used to
1713
+ identify that agent.
1616
1714
  $ref: "#/components/schemas/Max140Text"
1617
1715
  PstlAdr:
1716
+ description: >
1717
+ PostalAddress
1718
+
1719
+ Information that locates and identifies a specific address, as
1720
+ defined by postal services.
1618
1721
  $ref: "#/components/schemas/PostalAddress27"
1619
1722
  example:
1620
1723
  Id: 123
1621
- Nm: Oxford Street Branch
1724
+ LEI: 123
1725
+ Nm: Name
1622
1726
  PstlAdr:
1623
- Ctry: GB
1624
- AdrLine:
1625
- - 1 Oxford Street
1626
- - London
1627
- - UK
1727
+ AdrTp: ADDR
1728
+ Dept: Department
1729
+ SubDept: Sub department
1730
+ StrtNm: Street name
1731
+ BldgNb: Building number
1732
+ PstCd: Post code
1733
+ TwnNm: Town name
1734
+ CtrySubDvsn: Country subdivision
1735
+ Ctry: Country
1736
+ AdrLine: Address line
1628
1737
  CashAccount40:
1629
1738
  title: CashAccount40
1630
1739
  type: object
@@ -1632,14 +1741,48 @@ components:
1632
1741
  Provides the details to identify an account.
1633
1742
  properties:
1634
1743
  Id:
1744
+ description: >
1745
+ Identification
1746
+
1747
+ Unique and unambiguous identification for the account between the
1748
+ account owner and the account servicer.
1635
1749
  $ref: "#/components/schemas/AccountIdentification4Choice"
1636
1750
  Tp:
1751
+ description: |
1752
+ Type
1753
+ Specifies the nature, or use of the account.
1637
1754
  $ref: "#/components/schemas/CashAccountType2Choice"
1638
1755
  Ccy:
1756
+ description: >
1757
+ Currency
1758
+
1759
+ Definition: Identification of the currency in which the account is
1760
+ held.
1761
+
1762
+ Usage: Currency should only be used in case one and the same account
1763
+ number covers several currencies and the initiating party needs to
1764
+ identify which currency needs to be used for settlement on the
1765
+ account.
1639
1766
  $ref: "#/components/schemas/ActiveOrHistoricCurrencyCode"
1640
1767
  Nm:
1768
+ description: >
1769
+ Name
1770
+
1771
+ Definition: Name of the account, as assigned by the account
1772
+ servicing institution, in agreement with the account owner in order
1773
+ to provide an additional means of identification of the account.
1774
+
1775
+ Usage: The account name is different from the account owner name.
1776
+ The account name is used in certain user communities to provide a
1777
+ means of identifying the account, in addition to the account owner's
1778
+ identity and the account number.
1641
1779
  $ref: "#/components/schemas/Max70Text"
1642
1780
  Prxy:
1781
+ description: >
1782
+ Proxy
1783
+
1784
+ Specifies an alternate assumed name for the identification of the
1785
+ account.
1643
1786
  $ref: "#/components/schemas/ProxyAccountIdentification1"
1644
1787
  example:
1645
1788
  Id:
@@ -1657,8 +1800,14 @@ components:
1657
1800
  type: object
1658
1801
  properties:
1659
1802
  Cd:
1803
+ description: |
1804
+ Code
1805
+ Account type, in a coded form.
1660
1806
  $ref: "#/components/schemas/ExternalCashAccountType1Code"
1661
1807
  Prtry:
1808
+ description: |
1809
+ Proprietary
1810
+ Nature or use of the account in a proprietary form.
1662
1811
  $ref: "#/components/schemas/Max35Text"
1663
1812
  oneOf:
1664
1813
  - required:
@@ -1675,8 +1824,16 @@ components:
1675
1824
  type: object
1676
1825
  properties:
1677
1826
  Cd:
1827
+ description: >
1828
+ Code
1829
+
1830
+ Category purpose, as published in an external category purpose code
1831
+ list.
1678
1832
  $ref: "#/components/schemas/ExternalCategoryPurpose1Code"
1679
1833
  Prtry:
1834
+ description: |
1835
+ Proprietary
1836
+ Category purpose, in a proprietary form.
1680
1837
  $ref: "#/components/schemas/Max35Text"
1681
1838
  oneOf:
1682
1839
  - required:
@@ -1714,12 +1871,20 @@ components:
1714
1871
  example: DEBT
1715
1872
  ChargeType3Choice:
1716
1873
  title: ChargeType3Choice
1717
- description: ChargeType3Choice Specifies the type of charge.
1874
+ description: |
1875
+ ChargeType3Choice
1876
+ Specifies the type of charge.
1718
1877
  type: object
1719
1878
  properties:
1720
1879
  Cd:
1880
+ description: |
1881
+ Code
1882
+ Charge type, in a coded form.
1721
1883
  $ref: "#/components/schemas/ExternalChargeType1Code"
1722
1884
  Prtry:
1885
+ description: |
1886
+ Proprietary
1887
+ Type of charge in a proprietary form, as defined by the issuer.
1723
1888
  $ref: "#/components/schemas/GenericIdentification3"
1724
1889
  oneOf:
1725
1890
  - required:
@@ -1732,13 +1897,28 @@ components:
1732
1897
  title: Charges16
1733
1898
  description: |
1734
1899
  NOTE: Unsure on description.
1900
+
1901
+ Seemingly a generic schema for charges, with an amount, agent, and type.
1735
1902
  type: object
1736
1903
  properties:
1737
1904
  Amt:
1905
+ description: |
1906
+ Amount
1907
+
1908
+ Transaction charges to be paid by the charge bearer.
1738
1909
  $ref: "#/components/schemas/ActiveOrHistoricCurrencyAndAmount"
1739
1910
  Agt:
1911
+ description: >
1912
+ Agent
1913
+
1914
+ Agent that takes the transaction charges or to which the transaction
1915
+ charges are due.
1740
1916
  $ref: "#/components/schemas/BranchAndFinancialInstitutionIdentification8"
1741
1917
  Tp:
1918
+ description: |
1919
+ Type
1920
+
1921
+ Defines the type of charges.
1742
1922
  $ref: "#/components/schemas/ChargeType3Choice"
1743
1923
  required:
1744
1924
  - Amt
@@ -1784,8 +1964,16 @@ components:
1784
1964
  type: object
1785
1965
  properties:
1786
1966
  Cd:
1967
+ description: |
1968
+ Code
1969
+ Identification of a member of a clearing system
1787
1970
  $ref: "#/components/schemas/ExternalClearingSystemIdentification1Code"
1788
1971
  Prtry:
1972
+ description: >
1973
+ Proprietary
1974
+
1975
+ Identification code for a clearing system, that has not yet been
1976
+ identified in the list of clearing systems.
1789
1977
  $ref: "#/components/schemas/Max35Text"
1790
1978
  oneOf:
1791
1979
  - required:
@@ -1802,8 +1990,16 @@ components:
1802
1990
  type: object
1803
1991
  properties:
1804
1992
  ClrSysId:
1993
+ description: >
1994
+ ClearingSystemIdentification.
1995
+
1996
+ Specification of a pre-agreed offering between clearing agents or
1997
+ the channel through which the payment instruction is processed.
1805
1998
  $ref: "#/components/schemas/ClearingSystemIdentification2Choice"
1806
1999
  MmbId:
2000
+ description: |
2001
+ MemberIdentification.
2002
+ Identification of a member of a clearing system.
1807
2003
  $ref: "#/components/schemas/Max35Text"
1808
2004
  required:
1809
2005
  - MmbId
@@ -1818,30 +2014,79 @@ components:
1818
2014
  type: object
1819
2015
  properties:
1820
2016
  NmPrfx:
2017
+ description: |
2018
+ NamePrefix
2019
+ Specifies the terms used to formally address a person.
1821
2020
  $ref: "#/components/schemas/NamePrefix2Code"
1822
2021
  Nm:
2022
+ description: >
2023
+ Name
2024
+
2025
+ Name by which a party is known and which is usually used to identify
2026
+ that party.
1823
2027
  $ref: "#/components/schemas/Max140Text"
1824
2028
  PhneNb:
2029
+ description: >
2030
+ PhoneNumber
2031
+
2032
+ Collection of information that identifies a phone number, as defined
2033
+ by telecom services.
1825
2034
  $ref: "#/components/schemas/PhoneNumber"
1826
2035
  MobNb:
2036
+ description: >
2037
+ MobilePhoneNumber
2038
+
2039
+ Collection of information that identifies a mobile phone number, as
2040
+ defined by telecom services.
1827
2041
  $ref: "#/components/schemas/PhoneNumber"
1828
2042
  FaxNb:
2043
+ description: >
2044
+ FaxNumber
2045
+
2046
+ Collection of information that identifies a fax number, as defined
2047
+ by telecom services.
1829
2048
  $ref: "#/components/schemas/PhoneNumber"
1830
2049
  URLAdr:
2050
+ description: >
2051
+ URLAddress
2052
+
2053
+ Address for the Universal Resource Locator (URL), for example an
2054
+ address used over the www (HTTP) service.
1831
2055
  $ref: "#/components/schemas/Max2048Text"
1832
2056
  EmailAdr:
2057
+ description: |
2058
+ EmailAddress
2059
+ Address for electronic mail (e-mail).
1833
2060
  $ref: "#/components/schemas/Max256Text"
1834
2061
  EmailPurp:
2062
+ description: |
2063
+ EmailPurpose
2064
+ Purpose for which an email address may be used.
1835
2065
  $ref: "#/components/schemas/Max35Text"
1836
2066
  JobTitl:
2067
+ description: |
2068
+ JobTitle
2069
+ Title of the function.
1837
2070
  $ref: "#/components/schemas/Max35Text"
1838
2071
  Rspnsblty:
2072
+ description: |
2073
+ Responsibility
2074
+ Role of a person in an organisation.
1839
2075
  $ref: "#/components/schemas/Max35Text"
1840
2076
  Dept:
2077
+ description: |
2078
+ Department
2079
+ Identification of a division of a large organisation or building.
1841
2080
  $ref: "#/components/schemas/Max70Text"
1842
2081
  Othr:
2082
+ description: |
2083
+ OtherContact
2084
+ Contact details in another form.
1843
2085
  $ref: "#/components/schemas/OtherContact1"
1844
2086
  PrefrdMtd:
2087
+ description: |
2088
+ PreferredContactMethod
2089
+ Preferred method used to reach the contact.
1845
2090
  $ref: "#/components/schemas/PreferredContactMethod2Code"
1846
2091
  example:
1847
2092
  NmPrfx: Mr
@@ -1858,28 +2103,72 @@ components:
1858
2103
  type: object
1859
2104
  properties:
1860
2105
  NmPrfx:
2106
+ description: |
2107
+ NamePrefix
2108
+ Name prefix to be used before the name of the person.
1861
2109
  $ref: "#/components/schemas/NamePrefix2Code"
1862
2110
  Nm:
2111
+ description: >
2112
+ Name
2113
+
2114
+ Name by which a party is known and which is usually used to identify
2115
+ that party.
1863
2116
  $ref: "#/components/schemas/Max140Text"
1864
2117
  PhneNb:
2118
+ description: >
2119
+ PhoneNumber
2120
+
2121
+ Collection of information that identifies a phone number, as defined
2122
+ by telecom services.
1865
2123
  $ref: "#/components/schemas/PhoneNumber"
1866
2124
  MobNb:
2125
+ description: >
2126
+ MobilePhoneNumber
2127
+
2128
+ Collection of information that identifies a mobile phone number, as
2129
+ defined by telecom services.
1867
2130
  $ref: "#/components/schemas/PhoneNumber"
1868
2131
  FaxNb:
2132
+ description: >
2133
+ FaxNumber
2134
+
2135
+ Collection of information that identifies a fax number, as defined
2136
+ by telecom services.
1869
2137
  $ref: "#/components/schemas/PhoneNumber"
1870
2138
  EmailAdr:
2139
+ description: |
2140
+ EmailAddress
2141
+ Address for electronic mail (e-mail).
1871
2142
  $ref: "#/components/schemas/Max2048Text"
1872
2143
  EmailPurp:
2144
+ description: |
2145
+ EmailPurpose
2146
+ Purpose for which an email address may be used.
1873
2147
  $ref: "#/components/schemas/Max35Text"
1874
2148
  JobTitl:
2149
+ description: |
2150
+ JobTitle
2151
+ Title of the function.
1875
2152
  $ref: "#/components/schemas/Max35Text"
1876
2153
  Rspnsblty:
2154
+ description: |
2155
+ Responsibility
2156
+ Role of a person in an organisation.
1877
2157
  $ref: "#/components/schemas/Max35Text"
1878
2158
  Dept:
2159
+ description: |
2160
+ Department
2161
+ Identification of a division of a large organisation or building.
1879
2162
  $ref: "#/components/schemas/Max70Text"
1880
2163
  Othr:
2164
+ description: |
2165
+ Other
2166
+ : Contact details in another form.
1881
2167
  $ref: "#/components/schemas/OtherContact1"
1882
2168
  PrefrdMtd:
2169
+ description: |
2170
+ PreferredMethod
2171
+ Preferred method used to reach the contact.
1883
2172
  $ref: "#/components/schemas/PreferredContactMethod1Code"
1884
2173
  example:
1885
2174
  NmPrfx: Mr
@@ -1893,6 +2182,10 @@ components:
1893
2182
  type: string
1894
2183
  pattern: ^[A-Z]{2,2}$
1895
2184
  example: US
2185
+ description: >
2186
+ Code to identify a country, a dependency, or another area of particular
2187
+ geopolitical interest, on the basis of country names obtained from the
2188
+ United Nations (ISO 3166, Alpha-2 code).
1896
2189
  CreditTransferTransaction67:
1897
2190
  title: CreditTransferTransaction67
1898
2191
  description: >
@@ -1901,40 +2194,115 @@ components:
1901
2194
  type: object
1902
2195
  properties:
1903
2196
  PmtId:
2197
+ description: |
2198
+ PaymentIdentification
2199
+ Set of elements used to reference a payment instruction.
1904
2200
  $ref: "#/components/schemas/PaymentIdentification13"
1905
2201
  PmtTpInf:
2202
+ description: |
2203
+ PaymentTypeInformation
2204
+
2205
+ Set of elements used to further specify the type of transaction.
1906
2206
  $ref: "#/components/schemas/PaymentTypeInformation28"
1907
2207
  IntrBkSttlmAmt:
2208
+ description: >
2209
+ InterbankSettlementAmount
2210
+
2211
+ Amount of money moved between the instructing agent and the
2212
+ instructed agent.
1908
2213
  $ref: "#/components/schemas/ActiveCurrencyAndAmount"
1909
2214
  InstdAmt:
2215
+ description: >
2216
+ InstructedAmount
2217
+
2218
+ Amount of money to be moved between the debtor and creditor, before
2219
+ deduction of charges, expressed in the currency as ordered by the
2220
+ initiating party.
1910
2221
  $ref: "#/components/schemas/ActiveOrHistoricCurrencyAndAmount"
1911
2222
  XchgRate:
2223
+ description: >
2224
+ ExchangeRate
2225
+
2226
+ Factor used to convert an amount from one currency into another.
2227
+ This reflects the price at which one currency was bought with
2228
+ another currency.
1912
2229
  $ref: "#/components/schemas/BaseOneRate"
1913
2230
  ChrgBr:
2231
+ description: >
2232
+ ChargeBearer
2233
+
2234
+ Specifies which party/parties will bear the charges associated with
2235
+ the processing of the payment transaction.
1914
2236
  $ref: "#/components/schemas/ChargeBearerType1Code"
1915
2237
  ChrgsInf:
2238
+ description: >
2239
+ ChargesInformation
2240
+
2241
+ Provides information on the charges to be paid by the charge
2242
+ bearer(s) related to the payment transaction
1916
2243
  $ref: "#/components/schemas/Charges16"
1917
2244
  Dbtr:
2245
+ description: |
2246
+ Debtor
2247
+ Party that owes an amount of money to the (ultimate) creditor.
1918
2248
  $ref: "#/components/schemas/PartyIdentification272"
1919
2249
  DbtrAcct:
2250
+ description: >
2251
+ DebtorAccount
2252
+
2253
+ Unambiguous identification of the account of the debtor to which a
2254
+ debit entry will be made as a result of the transaction.
1920
2255
  $ref: "#/components/schemas/CashAccount40"
1921
2256
  DbtrAgt:
2257
+ description: |
2258
+ DebtorAgent
2259
+ Financial institution servicing an account for the debtor.
1922
2260
  $ref: "#/components/schemas/BranchAndFinancialInstitutionIdentification8"
1923
2261
  CdtrAgt:
2262
+ description: |
2263
+ CreditorAgent
2264
+ Financial institution servicing an account for the creditor.
1924
2265
  $ref: "#/components/schemas/BranchAndFinancialInstitutionIdentification8"
1925
2266
  Cdtr:
2267
+ description: |
2268
+ Creditor
2269
+ Party to which an amount of money is due.
1926
2270
  $ref: "#/components/schemas/PartyIdentification272"
1927
2271
  CdtrAcct:
2272
+ description: >
2273
+ CreditorAccount
2274
+
2275
+ Unambiguous identification of the account of the creditor to which a
2276
+ credit entry will be posted as a result of the payment transaction.
1928
2277
  $ref: "#/components/schemas/CashAccount40"
1929
2278
  InstrForCdtrAgt:
2279
+ description: >
2280
+ InstructionForCreditorAgent
2281
+
2282
+ Set of elements used to provide information on the remittance
2283
+ advice.
1930
2284
  $ref: "#/components/schemas/InstructionForCreditorAgent3"
1931
2285
  InstrForNxtAgt:
2286
+ description: >
2287
+ InstructionForNextAgent
2288
+
2289
+ Set of elements used to provide information on the remittance
2290
+ advice.
1932
2291
  $ref: "#/components/schemas/InstructionForNextAgent1"
1933
2292
  Purp:
2293
+ description: |
2294
+ Purpose
2295
+ Underlying reason for the payment transaction.
1934
2296
  $ref: "#/components/schemas/Purpose2Choice"
1935
2297
  RgltryRptg:
2298
+ description: |
2299
+ RegulatoryReporting
2300
+ Information needed due to regulatory and statutory requirements.
1936
2301
  $ref: "#/components/schemas/RegulatoryReporting3"
1937
2302
  Tax:
2303
+ description: |
2304
+ Tax
2305
+ Provides details on the tax.
1938
2306
  $ref: "#/components/schemas/TaxData1"
1939
2307
  VrfctnOfTerms:
1940
2308
  $ref: "#/components/schemas/CryptographicLockChoice"
@@ -2026,28 +2394,71 @@ components:
2026
2394
  type: object
2027
2395
  properties:
2028
2396
  PmtId:
2397
+ description: |
2398
+ PaymentIdentification
2399
+ Set of elements used to reference a payment instruction.
2029
2400
  $ref: "#/components/schemas/PaymentIdentification13"
2030
2401
  PmtTpInf:
2402
+ description: |
2403
+ PaymentTypeInformation
2404
+
2405
+ Set of elements used to further specify the type of transaction.
2031
2406
  $ref: "#/components/schemas/PaymentTypeInformation28"
2032
2407
  IntrBkSttlmAmt:
2408
+ description: >
2409
+ InterbankSettlementAmount
2410
+
2411
+ Amount of money moved between the instructing agent and the
2412
+ instructed agent.
2033
2413
  $ref: "#/components/schemas/ActiveCurrencyAndAmount"
2034
2414
  Dbtr:
2415
+ description: |
2416
+ Debtor
2417
+ Party that owes an amount of money to the (ultimate) creditor.
2035
2418
  $ref: "#/components/schemas/BranchAndFinancialInstitutionIdentification8"
2036
2419
  DbtrAcct:
2420
+ description: |
2421
+ DebtorAccount
2422
+ Account used to process a payment.
2037
2423
  $ref: "#/components/schemas/CashAccount40"
2038
2424
  DbtrAgt:
2425
+ description: |
2426
+ DebtorAgent
2427
+ Financial institution servicing an account for the debtor.
2039
2428
  $ref: "#/components/schemas/BranchAndFinancialInstitutionIdentification8"
2040
2429
  CdtrAgt:
2430
+ description: |
2431
+ CreditorAgent
2432
+ Financial institution servicing an account for the creditor.
2041
2433
  $ref: "#/components/schemas/BranchAndFinancialInstitutionIdentification8"
2042
2434
  Cdtr:
2435
+ description: |
2436
+ Creditor
2437
+ Party to which an amount of money is due.
2043
2438
  $ref: "#/components/schemas/BranchAndFinancialInstitutionIdentification8"
2044
2439
  CdtrAcct:
2440
+ description: |
2441
+ CreditorAccount
2442
+ Account to which a credit entry is made.
2045
2443
  $ref: "#/components/schemas/CashAccount40"
2046
2444
  InstrForCdtrAgt:
2445
+ description: >
2446
+ InstructionForCreditorAgent
2447
+
2448
+ Set of elements used to provide information on the remittance
2449
+ advice.
2047
2450
  $ref: "#/components/schemas/InstructionForCreditorAgent3"
2048
2451
  Purp:
2452
+ description: |
2453
+ Purpose
2454
+ Underlying reason for the payment transaction.
2049
2455
  $ref: "#/components/schemas/Purpose2Choice"
2050
2456
  VrfctnOfTerms:
2457
+ description: >
2458
+ VerificationOfTerms
2459
+
2460
+ Set of elements used to provide information on the underlying terms
2461
+ of the transaction.
2051
2462
  $ref: "#/components/schemas/CryptographicLockChoice"
2052
2463
  required:
2053
2464
  - PmtId
@@ -2112,12 +2523,24 @@ components:
2112
2523
  type: object
2113
2524
  properties:
2114
2525
  BirthDt:
2526
+ description: |
2527
+ BirthDate
2528
+ Date on which a person is born.
2115
2529
  $ref: "#/components/schemas/ISODate"
2116
2530
  PrvcOfBirth:
2531
+ description: |
2532
+ ProvinceOfBirth
2533
+ Province where a person was born.
2117
2534
  $ref: "#/components/schemas/Max35Text"
2118
2535
  CityOfBirth:
2536
+ description: |
2537
+ CityOfBirth
2538
+ City where a person was born.
2119
2539
  $ref: "#/components/schemas/Max35Text"
2120
2540
  CtryOfBirth:
2541
+ description: |
2542
+ CountryOfBirth
2543
+ Country where a person was born.
2121
2544
  $ref: "#/components/schemas/CountryCode"
2122
2545
  required:
2123
2546
  - BirthDt
@@ -2135,15 +2558,21 @@ components:
2135
2558
  type: object
2136
2559
  properties:
2137
2560
  FrDt:
2561
+ description: |
2562
+ FromDate
2563
+ Start date of the range.
2138
2564
  $ref: "#/components/schemas/ISODate"
2139
2565
  ToDt:
2566
+ description: |
2567
+ ToDate
2568
+ End date of the range.
2140
2569
  $ref: "#/components/schemas/ISODate"
2141
2570
  required:
2142
2571
  - FrDt
2143
2572
  - ToDt
2144
2573
  example:
2145
- FrDt: "2020-01-01"
2146
- ToDt: "2020-12-31"
2574
+ FrDt: "2022-01-01T00:00:00.000Z"
2575
+ ToDt: "2022-12-31T23:59:59.999Z"
2147
2576
  ErrorCode:
2148
2577
  title: ErrorCode
2149
2578
  type: string
@@ -2205,63 +2634,71 @@ components:
2205
2634
  type: object
2206
2635
  properties:
2207
2636
  GrpHdr:
2637
+ description: |
2638
+ GroupHeader.
2208
2639
  $ref: "#/components/schemas/GroupHeader129"
2209
2640
  CdtTrfTxInf:
2641
+ description: |
2642
+ CreditTransferTransactionInformation.
2210
2643
  $ref: "#/components/schemas/CreditTransferTransaction67"
2211
2644
  required:
2212
2645
  - GrpHdr
2213
2646
  - CdtTrfTxInf
2214
2647
  example:
2215
2648
  GrpHdr:
2216
- MsgId: 123456789
2649
+ MsgId: 12345
2217
2650
  CreDtTm: "2020-01-01T00:00:00Z"
2651
+ PmtInstrXpryDtTm: "2020-01-01T00:00:00Z"
2218
2652
  NbOfTxs: 1
2219
- CtrlSum: 100
2220
- InitgPty:
2221
- Nm: Initiating Party Name
2222
- Id:
2223
- OrgId:
2224
- Othr:
2225
- - Id: 123456789
2226
- SchmeNm:
2227
- Cd: 91
2228
- FwdgAgt:
2229
- FinInstnId:
2230
- BICFI: BBBBBBBB
2653
+ SttlmInf:
2654
+ SttlmMtd: INDA
2655
+ SttlmAcct:
2656
+ Id:
2657
+ IBAN: 123
2658
+ SttlmAcctOwnr:
2659
+ Nm: John Doe
2660
+ SttlmAcctSvcr:
2661
+ BICFI: 123
2662
+ CdtTrfTxInf:
2663
+ PmtId:
2664
+ InstrId: 123
2665
+ EndToEndId: 123
2666
+ PmtTpInf:
2667
+ InstrPrty: NORM
2668
+ InstdAmt:
2669
+ Amt: 123
2670
+ Ccy: EUR
2671
+ ChrgBr: SLEV
2672
+ CdtrAgt:
2673
+ FinInstnId:
2674
+ BICFI: 123
2675
+ Cdtr:
2676
+ Nm: John Doe
2677
+ CdtrAcct:
2678
+ Id:
2679
+ IBAN: 123
2680
+ RmtInf:
2681
+ Ustrd: Test
2231
2682
  CdtTrfTxInf:
2232
2683
  PmtId:
2233
- InstrId: 123456789
2234
- EndToEndId: 123456789
2684
+ InstrId: 123
2685
+ EndToEndId: 123
2235
2686
  PmtTpInf:
2236
2687
  InstrPrty: NORM
2237
- CtgyPurp:
2238
- Cd: SUPP
2239
- InstrForCdtrAgt:
2240
- FinInstnId:
2241
- BICFI: AAAAAAAA
2688
+ InstdAmt:
2689
+ Amt: 123
2690
+ Ccy: EUR
2691
+ ChrgBr: SLEV
2242
2692
  CdtrAgt:
2243
2693
  FinInstnId:
2244
- BICFI: AAAAAAAA
2694
+ BICFI: 123
2245
2695
  Cdtr:
2246
- Nm: Creditor Name
2247
- PstlAdr:
2248
- AdrLine:
2249
- - Creditor Address Line 1
2250
- - Creditor Address Line 2
2251
- - Creditor Address Line 3
2252
- - Creditor Address Line 4
2253
- - Creditor Address Line 5
2254
- Id:
2255
- OrgId:
2256
- Othr:
2257
- - Id: 123456789
2258
- SchmeNm:
2259
- Cd: 91
2696
+ Nm: John Doe
2260
2697
  CdtrAcct:
2261
2698
  Id:
2262
- IBAN: DE87123456781234567890
2699
+ IBAN: 123
2263
2700
  RmtInf:
2264
- Ustrd: Remittance Information
2701
+ Ustrd: Test
2265
2702
  Extension:
2266
2703
  title: Extension
2267
2704
  type: object
@@ -2413,8 +2850,16 @@ components:
2413
2850
  type: object
2414
2851
  properties:
2415
2852
  Cd:
2853
+ description: >
2854
+ Code
2855
+
2856
+ Name of the identification scheme, in a coded form as published in
2857
+ an external list.
2416
2858
  $ref: "#/components/schemas/ExternalFinancialInstitutionIdentification1Code"
2417
2859
  Prtry:
2860
+ description: |
2861
+ Proprietary
2862
+ Name of the identification scheme, in a free text form.
2418
2863
  $ref: "#/components/schemas/Max35Text"
2419
2864
  oneOf:
2420
2865
  - required:
@@ -2428,142 +2873,239 @@ components:
2428
2873
  type: object
2429
2874
  properties:
2430
2875
  BICFI:
2876
+ description: >
2877
+ BICFI
2878
+
2879
+ Code allocated to a financial institution by the ISO 9362
2880
+ Registration Authority as described in ISO 9362 "Banking - Banking
2881
+ telecommunication messages - Business identifier code (BIC)"
2431
2882
  $ref: "#/components/schemas/BICFIDec2014Identifier"
2432
2883
  ClrSysMmbId:
2884
+ description: |
2885
+ ClearingSystemMemberIdentification
2886
+ Information used to identify a member within a clearing system
2433
2887
  $ref: "#/components/schemas/ClearingSystemMemberIdentification2"
2434
2888
  LEI:
2889
+ description: |
2890
+ LEI
2891
+ Legal entity identifier of the financial institution.
2435
2892
  $ref: "#/components/schemas/LEIIdentifier"
2436
2893
  Nm:
2894
+ description: >
2895
+ Name
2896
+
2897
+ Name by which an agent is known and which is usually used to
2898
+ identify that agent
2437
2899
  $ref: "#/components/schemas/Max140Text"
2438
2900
  PstlAdr:
2901
+ description: >
2902
+ PostalAddress
2903
+
2904
+ Information that locates and identifies a specific address, as
2905
+ defined by postal services.
2439
2906
  $ref: "#/components/schemas/PostalAddress24"
2440
2907
  Othr:
2908
+ description: >
2909
+ Other
2910
+
2911
+ Unique identification of an agent, as assigned by an institution,
2912
+ using an identification scheme.
2441
2913
  $ref: "#/components/schemas/GenericFinancialIdentification1"
2442
2914
  example:
2443
- BICFI: BUKBGB22
2444
- Nm: Barclays Bank Plc
2915
+ BICFI: J5BMVH7D
2916
+ ClrSysMmbId:
2917
+ ClrSysId: 1234
2918
+ MmbId: 123
2919
+ LEI: 123
2920
+ Nm: Name
2445
2921
  PstlAdr:
2446
- Ctry: GB
2447
- AdrLine:
2448
- - 1 Churchill Place
2449
- - London
2450
- - UK
2922
+ AdrTp: ADDR
2923
+ Dept: Department
2924
+ SubDept: Sub department
2925
+ StrtNm: Street name
2926
+ BldgNb: Building number
2927
+ PstCd: Post code
2928
+ TwnNm: Town name
2929
+ CtrySubDvsn: Country subdivision
2930
+ Ctry: Country
2931
+ AdrLine: Address line
2932
+ Othr:
2933
+ Id: 123
2934
+ SchmeNm:
2935
+ Cd: 123
2936
+ Prtry: 123
2937
+ Issr: 123
2451
2938
  FinancialInstitutionIdentification23:
2452
2939
  title: FinancialInstitutionIdentification23
2453
2940
  type: object
2454
2941
  properties:
2455
2942
  BICFI:
2943
+ description: >
2944
+ BICFI
2945
+
2946
+ Code allocated to a financial institution by the ISO 9362
2947
+ Registration Authority as described in ISO 9362 "Banking - Banking
2948
+ telecommunication messages - Business identifier code (BIC)"
2456
2949
  $ref: "#/components/schemas/BICFIDec2014Identifier"
2457
2950
  ClrSysMmbId:
2951
+ description: |
2952
+ ClearingSystemMemberIdentification
2953
+ Information used to identify a member within a clearing system
2458
2954
  $ref: "#/components/schemas/ClearingSystemMemberIdentification2"
2459
2955
  LEI:
2956
+ description: |
2957
+ LEI
2958
+ Legal entity identifier of the financial institution.
2460
2959
  $ref: "#/components/schemas/LEIIdentifier"
2461
2960
  Nm:
2961
+ description: >
2962
+ Name
2963
+
2964
+ Name by which an agent is known and which is usually used to
2965
+ identify that agent
2462
2966
  $ref: "#/components/schemas/Max140Text"
2463
2967
  PstlAdr:
2968
+ description: >
2969
+ PostalAddress
2970
+
2971
+ Information that locates and identifies a specific address, as
2972
+ defined by postal services.
2464
2973
  $ref: "#/components/schemas/PostalAddress27"
2465
2974
  Othr:
2975
+ description: >
2976
+ Other
2977
+
2978
+ Unique identification of an agent, as assigned by an institution,
2979
+ using an identification scheme.
2466
2980
  $ref: "#/components/schemas/GenericFinancialIdentification1"
2467
2981
  example:
2468
- BICFI: BUKBGB22
2469
- Nm: Barclays Bank Plc
2982
+ BICFI: J5BMVH7D
2983
+ ClrSysMmbId:
2984
+ ClrSysId:
2985
+ Cd: CHQB
2986
+ MmbId: 123456789
2987
+ LEI: 123
2988
+ Nm: Name
2470
2989
  PstlAdr:
2471
- Ctry: GB
2472
- AdrLine:
2473
- - 1 Churchill Place
2474
- - London
2475
- - UK
2990
+ AdrTp: ADDR
2991
+ Dept: Department
2992
+ SubDept: Sub department
2993
+ StrtNm: Street name
2994
+ BldgNb: Building number
2995
+ PstCd: Post code
2996
+ TwnNm: Town name
2997
+ CtrySubDvsn: Country subdivision
2998
+ Ctry: Country
2999
+ AdrLine: Address line
3000
+ Othr:
3001
+ Id: 123
3002
+ SchmeNm:
3003
+ Cd: CHQB
3004
+ Issr: 123
2476
3005
  FxRequest_FICreditTransferProposal:
2477
3006
  title: FxRequest_FICreditTransferProposal
2478
3007
  type: object
2479
3008
  properties:
2480
3009
  GrpHdr:
3010
+ description: >
3011
+ GroupHeader
3012
+
3013
+ Set of characteristics shared by all individual transactions
3014
+ included in the message.
2481
3015
  $ref: "#/components/schemas/GroupHeader113"
2482
3016
  required:
2483
3017
  - GrpHdr
2484
3018
  example:
2485
3019
  GrpHdr:
2486
- MsgId: 123456789
3020
+ MsgId: 12345
2487
3021
  CreDtTm: "2020-01-01T00:00:00Z"
2488
3022
  NbOfTxs: 1
2489
- CtrlSum: 100
2490
- InitgPty:
2491
- Nm: Initiating Party Name
2492
- Id:
2493
- OrgId:
2494
- Othr:
2495
- - Id: 123456789
2496
- SchmeNm:
2497
- Cd: BIC
2498
- FwdgAgt:
2499
- FinInstnId:
2500
- BICFI: BICFID0
2501
- Dbtr:
2502
- Nm: Debtor Name
2503
- PstlAdr:
2504
- AdrLine:
2505
- - Debtor Address Line 1
2506
- - Debtor Address Line 2
2507
- Id:
2508
- OrgId:
2509
- Othr:
2510
- - Id: 123456789
2511
- SchmeNm:
2512
- Cd: BIC
2513
- DbtrAcct:
2514
- Id:
2515
- IBAN: BE71096123456769
2516
- DbtrAgt:
2517
- FinInstnId:
2518
- BICFI: BICFID0
2519
- Cdtr:
2520
- Nm: Creditor Name
2521
- PstlAdr:
2522
- AdrLine:
2523
- - Creditor Address Line 1
2524
- - Creditor Address Line 2
2525
- Id:
2526
- OrgId:
2527
- Othr:
2528
- - Id: 123456789
2529
- SchmeNm:
2530
- Cd: BIC
2531
- CdtrAcct:
2532
- Id:
2533
- IBAN: BE71096123456769
2534
- CdtrAgt:
2535
- FinInstnId:
2536
- BICFI: BICFID0
3023
+ TtlIntrBkSttlmAmt:
3024
+ Ccy: EUR
3025
+ Value: 100
3026
+ SttlmInf:
3027
+ SttlmMtd: INDA
3028
+ SttlmAcct:
3029
+ Id:
3030
+ IBAN: BE71096123456769
3031
+ Ccy: EUR
3032
+ SttlmAcctOwnr:
3033
+ Nm: Name
3034
+ SttlmAcctSvcr:
3035
+ Nm: Name
3036
+ SttlmAgt:
3037
+ FinInstnId:
3038
+ BICFI: BIC
3039
+ PmtTpInf:
3040
+ InstrPrty: NORM
3041
+ CtgyPurp: CASH
2537
3042
  CdtTrfTxInf:
2538
- - PmtId:
2539
- InstrId: 123456789
2540
- EndToEndId: 123456789
2541
- Amt:
2542
- InstdAmt:
2543
- Ccy: EUR
2544
- Amt: 100
2545
- CdtrAgt:
3043
+ PmtId:
3044
+ InstrId: 12345
3045
+ EndToEndId: 12345
3046
+ Amt:
3047
+ InstdAmt:
3048
+ Ccy: EUR
3049
+ Value: 100
3050
+ Cdtr:
3051
+ Nm: Name
3052
+ CdtrAcct:
3053
+ Id:
3054
+ IBAN: BE71096123456769
3055
+ Ccy: EUR
3056
+ CdtrAgt:
3057
+ FinInstnId:
3058
+ BICFI: BIC
3059
+ Dbtr:
3060
+ Nm: Name
3061
+ DbtrAcct:
3062
+ Id:
3063
+ IBAN: BE71096123456769
3064
+ Ccy: EUR
3065
+ DbtrAgt:
3066
+ FinInstnId:
3067
+ BICFI: BIC
3068
+ IntrBkSttlmAmt:
3069
+ Ccy: EUR
3070
+ Value: 100
3071
+ PmtTpInf:
3072
+ InstrPrty: NORM
3073
+ ClrChanl: RTGS
3074
+ SvcLvl:
3075
+ Cd: SEPA
3076
+ LclInstrm:
3077
+ Cd: CORE
3078
+ CtgyPurp:
3079
+ Cd: CASH
3080
+ RgltryRptg:
3081
+ Dbtr:
3082
+ Nm: Name
3083
+ DbtrAcct:
3084
+ Id:
3085
+ IBAN: BE71096123456769
3086
+ Ccy: EUR
3087
+ DbtrAgt:
2546
3088
  FinInstnId:
2547
- BICFI: BICFID0
3089
+ BICFI: BIC
2548
3090
  Cdtr:
2549
- Nm: Creditor Name
2550
- PstlAdr:
2551
- AdrLine:
2552
- - Creditor Address Line 1
2553
- - Creditor Address Line 2
2554
- Id:
2555
- OrgId:
2556
- Othr:
2557
- - Id: 123456789
2558
- SchmeNm:
2559
- Cd: BIC
3091
+ Nm: Name
2560
3092
  FxResponse_FICreditTransferConfirmation:
2561
3093
  title: FxResponse_FICreditTransferConfirmation
2562
3094
  type: object
2563
3095
  properties:
2564
3096
  GrpHdr:
3097
+ description: >
3098
+ GroupHeader
3099
+
3100
+ Set of characteristics shared by all individual transactions
3101
+ included in the message.
2565
3102
  $ref: "#/components/schemas/GroupHeader113"
2566
3103
  CdtTrfTxInf:
3104
+ description: >
3105
+ CreditTransferTransactionInformation
3106
+
3107
+ Set of elements providing information specific to the individual
3108
+ credit transfer(s).
2567
3109
  $ref: "#/components/schemas/CreditTransferTransaction68"
2568
3110
  required:
2569
3111
  - GrpHdr
@@ -2644,8 +3186,18 @@ components:
2644
3186
  type: object
2645
3187
  properties:
2646
3188
  GrpHdr:
3189
+ description: >
3190
+ GroupHeader.
3191
+
3192
+ Set of characteristics shared by all individual transactions
3193
+ included in the message.
2647
3194
  $ref: "#/components/schemas/GroupHeader129"
2648
3195
  CdtTrfTxInf:
3196
+ description: >
3197
+ CreditTransferTransactionInformation.
3198
+
3199
+ Set of elements providing information specific to the individual
3200
+ credit transfer(s).
2649
3201
  $ref: "#/components/schemas/CreditTransferTransaction68"
2650
3202
  required:
2651
3203
  - GrpHdr
@@ -2702,10 +3254,19 @@ components:
2702
3254
  type: object
2703
3255
  properties:
2704
3256
  Id:
3257
+ description: |
3258
+ Identification
3259
+ Identification assigned by an institution.
2705
3260
  $ref: "#/components/schemas/Max34Text"
2706
3261
  SchmeNm:
3262
+ description: |
3263
+ SchemeName
3264
+ Name of the identification scheme.
2707
3265
  $ref: "#/components/schemas/AccountSchemeName1Choice"
2708
3266
  Issr:
3267
+ description: |
3268
+ Issuer
3269
+ Entity that assigns the identification.
2709
3270
  $ref: "#/components/schemas/Max35Text"
2710
3271
  required:
2711
3272
  - Id
@@ -2719,10 +3280,19 @@ components:
2719
3280
  type: object
2720
3281
  properties:
2721
3282
  Id:
3283
+ description: |
3284
+ Identification
3285
+ Unique and unambiguous identification of a person.
2722
3286
  $ref: "#/components/schemas/Max35Text"
2723
3287
  SchmeNm:
3288
+ description: |
3289
+ SchemeName
3290
+ Name of the identification scheme.
2724
3291
  $ref: "#/components/schemas/FinancialIdentificationSchemeName1Choice"
2725
3292
  Issr:
3293
+ description: |
3294
+ Issuer
3295
+ Entity that assigns the identification.
2726
3296
  $ref: "#/components/schemas/Max35Text"
2727
3297
  required:
2728
3298
  - Id
@@ -2736,8 +3306,16 @@ components:
2736
3306
  type: object
2737
3307
  properties:
2738
3308
  Id:
3309
+ description: >
3310
+ Identification
3311
+
3312
+ Name or number assigned by an entity to enable recognition of that
3313
+ entity, for example, account identifier.
2739
3314
  $ref: "#/components/schemas/Max35Text"
2740
3315
  Issr:
3316
+ description: |
3317
+ Issuer
3318
+ Entity that assigns the identification.
2741
3319
  $ref: "#/components/schemas/Max35Text"
2742
3320
  required:
2743
3321
  - Id
@@ -2749,10 +3327,21 @@ components:
2749
3327
  type: object
2750
3328
  properties:
2751
3329
  Id:
3330
+ description: >
3331
+ Identification
3332
+
3333
+ Proprietary information, often a code, issued by the data source
3334
+ scheme issuer
2752
3335
  $ref: "#/components/schemas/Exact4AlphaNumericText"
2753
3336
  Issr:
3337
+ description: |
3338
+ Issuer
3339
+ Entity that assigns the identification.
2754
3340
  $ref: "#/components/schemas/Max35Text"
2755
3341
  SchmeNm:
3342
+ description: |
3343
+ SchemeName
3344
+ Short textual description of the scheme.
2756
3345
  $ref: "#/components/schemas/Max35Text"
2757
3346
  required:
2758
3347
  - Id
@@ -2766,10 +3355,19 @@ components:
2766
3355
  type: object
2767
3356
  properties:
2768
3357
  Id:
3358
+ description: |
3359
+ Identification
3360
+ Identification assigned by an institution.
2769
3361
  $ref: "#/components/schemas/Max35Text"
2770
3362
  SchmeNm:
3363
+ description: |
3364
+ SchemeName
3365
+ Name of the identification scheme.
2771
3366
  $ref: "#/components/schemas/OrganisationIdentificationSchemeName1Choice"
2772
3367
  Issr:
3368
+ description: |
3369
+ Issuer
3370
+ Entity that assigns the identification.
2773
3371
  $ref: "#/components/schemas/Max35Text"
2774
3372
  required:
2775
3373
  - Id
@@ -2783,10 +3381,19 @@ components:
2783
3381
  type: object
2784
3382
  properties:
2785
3383
  Id:
3384
+ description: |
3385
+ Identification
3386
+ Identification assigned by an institution.
2786
3387
  $ref: "#/components/schemas/Max256Text"
2787
3388
  SchmeNm:
3389
+ description: |-
3390
+ SchemeName
3391
+ Name of the identification scheme.
2788
3392
  $ref: "#/components/schemas/OrganisationIdentificationSchemeName1Choice"
2789
3393
  Issr:
3394
+ description: |
3395
+ Issuer
3396
+ Entity that assigns the identification.
2790
3397
  $ref: "#/components/schemas/Max35Text"
2791
3398
  required:
2792
3399
  - Id
@@ -2800,10 +3407,19 @@ components:
2800
3407
  type: object
2801
3408
  properties:
2802
3409
  Id:
3410
+ description: |
3411
+ Identification
3412
+ Unique and unambiguous identification of a person.
2803
3413
  $ref: "#/components/schemas/Max35Text"
2804
3414
  SchmeNm:
3415
+ description: |
3416
+ SchemeName
3417
+ Name of the identification scheme.
2805
3418
  $ref: "#/components/schemas/PersonIdentificationSchemeName1Choice"
2806
3419
  Issr:
3420
+ description: |
3421
+ Issuer
3422
+ Entity that assigns the identification.
2807
3423
  $ref: "#/components/schemas/Max35Text"
2808
3424
  required:
2809
3425
  - Id
@@ -2817,10 +3433,19 @@ components:
2817
3433
  type: object
2818
3434
  properties:
2819
3435
  Id:
3436
+ description: |
3437
+ Identification
3438
+ Unique and unambiguous identification of a person.
2820
3439
  $ref: "#/components/schemas/Max256Text"
2821
3440
  SchmeNm:
3441
+ description: |
3442
+ SchemeName
3443
+ Name of the identification scheme.
2822
3444
  $ref: "#/components/schemas/PersonIdentificationSchemeName1Choice"
2823
3445
  Issr:
3446
+ description: |
3447
+ Issuer
3448
+ Entity that assigns the identification.
2824
3449
  $ref: "#/components/schemas/Max35Text"
2825
3450
  required:
2826
3451
  - Id
@@ -2834,10 +3459,23 @@ components:
2834
3459
  type: object
2835
3460
  properties:
2836
3461
  Assgnmt:
3462
+ description: |
3463
+ Assignment
3464
+ Information related to the identification assignment.
2837
3465
  $ref: "#/components/schemas/IdentificationAssignment3"
2838
3466
  Rpt:
3467
+ description: >
3468
+ Report
3469
+
3470
+ Information concerning the verification of the identification data
3471
+ for which verification was requested.
2839
3472
  $ref: "#/components/schemas/VerificationReport4"
2840
3473
  SplmtryData:
3474
+ description: >
3475
+ SupplementaryData
3476
+
3477
+ Additional information that cannot be captured in the structured
3478
+ elements and/or any other specific block.
2841
3479
  $ref: "#/components/schemas/SupplementaryData1"
2842
3480
  required:
2843
3481
  - Assgnmt
@@ -2892,59 +3530,79 @@ components:
2892
3530
  type: object
2893
3531
  properties:
2894
3532
  Assgnmt:
3533
+ description: |
3534
+ Assignment
3535
+ Identifies the identification assignment.
2895
3536
  $ref: "#/components/schemas/IdentificationAssignment3"
2896
3537
  Rpt:
3538
+ description: >
3539
+ Report
3540
+
3541
+ Information concerning the verification of the identification data
3542
+ for which verification was requested.
2897
3543
  $ref: "#/components/schemas/VerificationReport4"
2898
3544
  SplmtryData:
2899
- $ref: "#/components/schemas/SupplementaryData1"
2900
- required:
2901
- - Assgnmt
2902
- - Rpt
2903
- example:
2904
- Assgnmt:
2905
- Id: 123
2906
- CreDtTm: "2013-03-07T16:30:00"
2907
- Assgnr:
2908
- Id:
2909
- Id: 123
2910
- SchmeNm:
2911
- Cd: IBAN
2912
- Issr: BIC
2913
- Assgne:
2914
- Id:
2915
- Id: 123
2916
- SchmeNm:
2917
- Cd: IBAN
2918
- Issr: BIC
2919
- Rpt:
2920
- Id: 123
2921
- CreDtTm: "2013-03-07T16:30:00"
2922
- RptgPty:
2923
- Id:
2924
- Id: 123
2925
- SchmeNm:
2926
- Cd: IBAN
2927
- Issr: BIC
2928
- RptdPty:
2929
- Id:
2930
- Id: 123
2931
- SchmeNm:
2932
- Cd: IBAN
2933
- Issr: BIC
2934
- RptdDoc:
2935
- Nb: 123
2936
- RltdDt: "2013-03-07"
2937
- RltdDtTp:
2938
- Cd: 123
2939
- Rsn:
2940
- Cd: 123
2941
- Prtry: 123
2942
- SplmtryData:
2943
- PlcAndNm: 123
2944
- Envlp: 123
2945
- RltdDt: "2013-03-07"
2946
- RltdDtTp:
2947
- Cd: 123
3545
+ description: >
3546
+ SupplementaryData
3547
+
3548
+ Additional information that cannot be captured in the structured
3549
+ elements and/or any other specific block.
3550
+ $ref: "#/components/schemas/SupplementaryData1"
3551
+ required:
3552
+ - Assgnmt
3553
+ - Rpt
3554
+ example:
3555
+ Assgnmt:
3556
+ MsgId: 123
3557
+ CreDtTm: "2020-01-01T00:00:00Z"
3558
+ Assgnr:
3559
+ OrgId:
3560
+ Othr:
3561
+ Id: 123
3562
+ SchmeNm:
3563
+ Cd: BIC
3564
+ Issr: BIC
3565
+ Assgne:
3566
+ OrgId:
3567
+ Othr:
3568
+ Id: DFSPID
3569
+ Rpt:
3570
+ OrgnlId: 12345678
3571
+ Vrfctn: true
3572
+ UpdtdPtyAndAcctId:
3573
+ Pty:
3574
+ Nm: John Doe
3575
+ PstlAdr:
3576
+ AdrTp: ADDR
3577
+ Dept: Dept
3578
+ SubDept: SubDept
3579
+ StrtNm: StrtNm
3580
+ BldgNb: BldgNb
3581
+ BldgNm: BldgNm
3582
+ Flr: Flr
3583
+ PstBx: PstBx
3584
+ Room: Room
3585
+ PstCd: PstCd
3586
+ TwnNm: TwnNm
3587
+ TwnLctnNm: TwnLctnNm
3588
+ DstrctNm: DstrctNm
3589
+ CtrySubDvsn: CtrySubDvsn
3590
+ Ctry: Ctry
3591
+ AdrLine: AdrLine
3592
+ Id:
3593
+ OrgId:
3594
+ Othr:
3595
+ Id: 18761231234
3596
+ SchmeNm:
3597
+ Prtry: MSISDN
3598
+ CtryOfRes: BE
3599
+ CtctDtls:
3600
+ NmPrfx: Mr
3601
+ Nm: John Doe
3602
+ PhneNb: +123-123-321
3603
+ MobNb: +123-123-321
3604
+ FaxNb: +123-123-321
3605
+ EmailAdr: example@example.com
2948
3606
  GroupHeader113:
2949
3607
  title: GroupHeader113
2950
3608
  description: >
@@ -3026,10 +3684,32 @@ components:
3026
3684
  type: object
3027
3685
  properties:
3028
3686
  MsgId:
3687
+ description: >
3688
+ MessageIdentification
3689
+
3690
+ Definition: Point to point reference, as assigned by the instructing
3691
+ party, and sent to the next party in the chain to unambiguously
3692
+ identify the message.
3693
+
3694
+ Usage: The instructing party has to make sure that
3695
+ MessageIdentification is unique per instructed party for a
3696
+ pre-agreed period.
3029
3697
  $ref: "#/components/schemas/Max35Text"
3030
3698
  CreDtTm:
3699
+ description: |
3700
+ CreationDateTime
3701
+ Date and time at which the message was created.
3031
3702
  $ref: "#/components/schemas/ISODateTime"
3032
3703
  TxInfAndSts:
3704
+ description: >
3705
+ TransactionInformationAndStatus
3706
+
3707
+ Definition: Agent that instructs the next party in the chain to
3708
+ carry out the (set of) instruction(s).
3709
+
3710
+ Usage: The instructing agent is the party sending the status message
3711
+ and not the party that sent the original instruction that is being
3712
+ reported on.
3033
3713
  $ref: "#/components/schemas/PaymentTransaction163"
3034
3714
  required:
3035
3715
  - MsgId
@@ -3186,10 +3866,23 @@ components:
3186
3866
  MsgId:
3187
3867
  $ref: "#/components/schemas/Max35Text"
3188
3868
  CreDtTm:
3869
+ description: |
3870
+ CreationDateTime
3871
+ Date and time at which the identification assignment was created.
3189
3872
  $ref: "#/components/schemas/ISODateTime"
3190
3873
  Assgnr:
3874
+ description: >
3875
+ Assignor
3876
+
3877
+ Party that assigns the identification assignment to another party.
3878
+ This is also the sender of the message.
3191
3879
  $ref: "#/components/schemas/Party40Choice"
3192
3880
  Assgne:
3881
+ description: >
3882
+ Assignee
3883
+
3884
+ Party that the identification assignment is assigned to. This is
3885
+ also the receiver of the message.
3193
3886
  $ref: "#/components/schemas/Party40Choice"
3194
3887
  required:
3195
3888
  - MsgId
@@ -3218,10 +3911,21 @@ components:
3218
3911
  type: object
3219
3912
  properties:
3220
3913
  Pty:
3914
+ description: >
3915
+ Party
3916
+
3917
+ Account owner that owes an amount of money or to whom an amount of
3918
+ money is due.
3221
3919
  $ref: "#/components/schemas/PartyIdentification135"
3222
3920
  Acct:
3921
+ description: |
3922
+ Account
3923
+ Unambiguous identification of the account of a party.
3223
3924
  $ref: "#/components/schemas/CashAccount40"
3224
3925
  Agt:
3926
+ description: |
3927
+ Agent
3928
+ Financial institution servicing an account for a party.
3225
3929
  $ref: "#/components/schemas/BranchAndFinancialInstitutionIdentification6"
3226
3930
  example:
3227
3931
  Pty:
@@ -3240,6 +3944,16 @@ components:
3240
3944
  title: IdentificationVerificationIndicator
3241
3945
  type: boolean
3242
3946
  example: true
3947
+ description: >
3948
+ Definition: Identifies whether the party and/or account information
3949
+ received is correct.
3950
+
3951
+
3952
+ • Meaning When True: Indicates that the identification information
3953
+ received is correct.
3954
+
3955
+ • Meaning When False: Indicates that the identification information
3956
+ received is incorrect
3243
3957
  Instruction4Code:
3244
3958
  title: Instruction4Code
3245
3959
  description: >
@@ -3265,8 +3979,20 @@ components:
3265
3979
  type: object
3266
3980
  properties:
3267
3981
  Cd:
3982
+ description: >
3983
+ Code
3984
+
3985
+ Coded information related to the processing of the payment
3986
+ instruction, provided by the initiating party, and intended for the
3987
+ creditor's agent.
3268
3988
  $ref: "#/components/schemas/ExternalCreditorAgentInstruction1Code"
3269
3989
  InstrInf:
3990
+ description: >
3991
+ InstructionInformation
3992
+
3993
+ Further information complementing the coded instruction or
3994
+ instruction to the creditor's agent that is bilaterally agreed or
3995
+ specific to a user community.
3270
3996
  $ref: "#/components/schemas/Max140Text"
3271
3997
  example:
3272
3998
  Cd: PHOA
@@ -3280,8 +4006,20 @@ components:
3280
4006
  type: object
3281
4007
  properties:
3282
4008
  Cd:
4009
+ description: >
4010
+ Code
4011
+
4012
+ Coded information related to the processing of the payment
4013
+ instruction, provided by the initiating party, and intended for the
4014
+ next agent in the payment chain.
3283
4015
  $ref: "#/components/schemas/Instruction4Code"
3284
4016
  InstrInf:
4017
+ description: >
4018
+ InstructionInformation
4019
+
4020
+ Further information complementing the coded instruction or
4021
+ instruction to the next agent that is bilaterally agreed or specific
4022
+ to a user community.
3285
4023
  $ref: "#/components/schemas/Max140Text"
3286
4024
  example:
3287
4025
  Cd: PHOA
@@ -3300,8 +4038,16 @@ components:
3300
4038
  type: object
3301
4039
  properties:
3302
4040
  Cd:
4041
+ description: >
4042
+ Code
4043
+
4044
+ Specifies the local instrument, as published in an external local
4045
+ instrument code list.
3303
4046
  $ref: "#/components/schemas/ExternalLocalInstrument1Code"
3304
4047
  Prtry:
4048
+ description: |
4049
+ Proprietary
4050
+ Specifies the local instrument, as a proprietary code
3305
4051
  $ref: "#/components/schemas/Max35Text"
3306
4052
  oneOf:
3307
4053
  - required:
@@ -3436,10 +4182,23 @@ components:
3436
4182
  type: object
3437
4183
  properties:
3438
4184
  AnyBIC:
4185
+ description: |
4186
+ AnyBIC
4187
+ Business identification code of the organisation.
3439
4188
  $ref: "#/components/schemas/AnyBICDec2014Identifier"
3440
4189
  LEI:
4190
+ description: >
4191
+ LEI
4192
+
4193
+ Legal entity identification as an alternate identification for a
4194
+ party.
3441
4195
  $ref: "#/components/schemas/LEIIdentifier"
3442
4196
  Othr:
4197
+ description: >
4198
+ Other
4199
+
4200
+ Unique identification of an organisation, as assigned by an
4201
+ institution, using an identification scheme.
3443
4202
  $ref: "#/components/schemas/GenericOrganisationIdentification1"
3444
4203
  example:
3445
4204
  AnyBIC: BICFI
@@ -3456,10 +4215,23 @@ components:
3456
4215
  type: object
3457
4216
  properties:
3458
4217
  AnyBIC:
4218
+ description: |
4219
+ AnyBIC
4220
+ Business identification code of the organisation.
3459
4221
  $ref: "#/components/schemas/AnyBICDec2014Identifier"
3460
4222
  LEI:
4223
+ description: >
4224
+ LEI
4225
+
4226
+ Legal entity identification as an alternate identification for a
4227
+ party.
3461
4228
  $ref: "#/components/schemas/LEIIdentifier"
3462
4229
  Othr:
4230
+ description: >
4231
+ Other
4232
+
4233
+ Unique identification of an organisation, as assigned by an
4234
+ institution, using an identification scheme.
3463
4235
  $ref: "#/components/schemas/GenericOrganisationIdentification3"
3464
4236
  example:
3465
4237
  AnyBIC: BICFI
@@ -3476,8 +4248,16 @@ components:
3476
4248
  type: object
3477
4249
  properties:
3478
4250
  Cd:
4251
+ description: >
4252
+ Code
4253
+
4254
+ Name of the identification scheme, in a coded form as published in
4255
+ an external list.
3479
4256
  $ref: "#/components/schemas/ExternalOrganisationIdentification1Code"
3480
4257
  Prtry:
4258
+ description: |
4259
+ Proprietary
4260
+ Name of the identification scheme, in a free text form.
3481
4261
  $ref: "#/components/schemas/Max35Text"
3482
4262
  oneOf:
3483
4263
  - required:
@@ -3494,8 +4274,16 @@ components:
3494
4274
  type: object
3495
4275
  properties:
3496
4276
  ChanlTp:
4277
+ description: >
4278
+ ChannelType
4279
+
4280
+ Method used to contact the financial institution's contact for the
4281
+ specific tax region.
3497
4282
  $ref: "#/components/schemas/Max4Text"
3498
4283
  Id:
4284
+ description: |
4285
+ Identifier
4286
+ Communication value such as phone number or email address.
3499
4287
  $ref: "#/components/schemas/Max128Text"
3500
4288
  required:
3501
4289
  - ChanlTp
@@ -3550,74 +4338,25 @@ components:
3550
4338
  - GrpHdr
3551
4339
  example:
3552
4340
  GrpHdr:
3553
- MsgId: 123
4341
+ MsgId: 12345
3554
4342
  CreDtTm: "2020-01-01T00:00:00Z"
3555
- NbOfTxs: 1
3556
- SttlmInf:
3557
- SttlmMtd: INDA
3558
- SttlmDt: "2020-01-01"
3559
- SttlmTmIndctn: RTGS
3560
- SttlmTmReq: "2020-01-01T00:00:00Z"
3561
- SttlmAcct:
3562
- Id:
3563
- Othr:
3564
- Id: 123
3565
- SchmeNm:
3566
- Cd: IBAN
3567
- Issr: BIC
3568
- ClrSys:
3569
- Prtry: 123
3570
- InstgAgt:
3571
- FinInstnId:
3572
- BICFI: 123
3573
- InstdAgt:
3574
- FinInstnId:
3575
- BICFI: 123
3576
- InstgAgt:
3577
- FinInstnId:
3578
- BICFI: 123
3579
- InstdAgt:
3580
- FinInstnId:
3581
- BICFI: 123
3582
- IntrBkSttlmAmt:
3583
- Amt: 123
3584
- Ccy: EUR
3585
- IntrBkSttlmDt: "2020-01-01"
3586
- TxSts: ACCP
3587
- StsRsnInf:
3588
- Orgtr:
3589
- Id:
3590
- Othr:
3591
- Id: 123
3592
- SchmeNm:
3593
- Cd: IBAN
3594
- Issr: BIC
3595
- Rsn:
3596
- Cd: 123
3597
- Prtry: 123
3598
4343
  TxInfAndSts:
3599
- OrgnlInstrId: 123
3600
- OrgnlEndToEndId: 123
3601
- TxSts: ACCP
4344
+ StsId: 12345
4345
+ OrgnlInstrId: 12345
4346
+ OrgnlEndToEndId: 12345
4347
+ OrgnlTxId: 12345
4348
+ OrgnlUETR: 123e4567-e89b-12d3-a456-426614174000
4349
+ TxSts: RJCT
3602
4350
  StsRsnInf:
3603
- Orgtr:
3604
- Id:
3605
- Othr:
3606
- Id: 123
3607
- SchmeNm:
3608
- Cd: IBAN
3609
- Issr: BIC
3610
- Rsn:
3611
- Cd: 123
3612
- Prtry: 123
3613
- ChrgsInf:
3614
- Amt: 123
3615
- Ccy: EUR
3616
- IntrBkSttlmAmt:
3617
- Amt: 123
3618
- Ccy: EUR
3619
- IntrBkSttlmDt: "2020-01-01"
3620
- SttlmTmIndctn: RTGS
4351
+ Rsn: RSN
4352
+ AddtlInf: ADDITIONAL
4353
+ AccptncDtTm: "2020-01-01T00:00:00Z"
4354
+ AcctSvcrRef: ACCTSVCRREF
4355
+ ClrSysRef: CLRSYSREF
4356
+ ExctnConf: 1234567890ABCDEF
4357
+ SplmtryData:
4358
+ PlcAndNm: PLACE
4359
+ Envlp: ENVELOPE
3621
4360
  Party38Choice:
3622
4361
  title: Party38Choice
3623
4362
  description: |
@@ -3625,8 +4364,16 @@ components:
3625
4364
  type: object
3626
4365
  properties:
3627
4366
  OrgId:
4367
+ description: |
4368
+ Organisation
4369
+ Unique and unambiguous way to identify an organisation.
3628
4370
  $ref: "#/components/schemas/OrganisationIdentification29"
3629
4371
  PrvtId:
4372
+ description: >
4373
+ PrivateIdentification
4374
+
4375
+ Unique and unambiguous identification of a person, for example a
4376
+ passport.
3630
4377
  $ref: "#/components/schemas/PersonIdentification13"
3631
4378
  oneOf:
3632
4379
  - required:
@@ -3643,12 +4390,18 @@ components:
3643
4390
  Party40Choice:
3644
4391
  title: Party40Choice
3645
4392
  description: |
3646
- Nature or use of the account.
4393
+ Identification of a person, an organisation or a financial institution.
3647
4394
  type: object
3648
4395
  properties:
3649
4396
  Pty:
4397
+ description: |
4398
+ Party
4399
+ Identification of a person or an organisation.
3650
4400
  $ref: "#/components/schemas/PartyIdentification135"
3651
4401
  Agt:
4402
+ description: |
4403
+ Agent
4404
+ Identification of a financial institution.
3652
4405
  $ref: "#/components/schemas/BranchAndFinancialInstitutionIdentification6"
3653
4406
  oneOf:
3654
4407
  - required:
@@ -3681,12 +4434,20 @@ components:
3681
4434
  Party52Choice:
3682
4435
  title: Party52Choice
3683
4436
  description: |
3684
- Nature or use of the account.
4437
+ NOTE: Unsure on the description.
3685
4438
  type: object
3686
4439
  properties:
3687
4440
  OrgId:
4441
+ description: |
4442
+ Organisation
4443
+ Unique and unambiguous way to identify an organisation.
3688
4444
  $ref: "#/components/schemas/OrganisationIdentification39"
3689
4445
  PrvtId:
4446
+ description: >
4447
+ Person
4448
+
4449
+ Unique and unambiguous identification of a person, for example a
4450
+ passport
3690
4451
  $ref: "#/components/schemas/PersonIdentification18"
3691
4452
  oneOf:
3692
4453
  - required:
@@ -3707,26 +4468,60 @@ components:
3707
4468
  type: object
3708
4469
  properties:
3709
4470
  Nm:
4471
+ description: >
4472
+ Name
4473
+
4474
+ Name by which a party is known and which is usually used to identify
4475
+ that party.
3710
4476
  $ref: "#/components/schemas/Max140Text"
3711
4477
  PstlAdr:
4478
+ description: >
4479
+ PostalAddress
4480
+
4481
+ Information that locates and identifies a specific address, as
4482
+ defined by postal services.
3712
4483
  $ref: "#/components/schemas/PostalAddress24"
3713
4484
  Id:
4485
+ description: |
4486
+ Identification
4487
+ Unique and unambiguous way to identify an organisation.
3714
4488
  $ref: "#/components/schemas/Party38Choice"
3715
4489
  CtryOfRes:
4490
+ description: >
4491
+ CountryOfResidence Country in which a person resides (the place of a
4492
+ person's home). In the case of a company, it is the country from
4493
+ which the affairs of that company are directed.
3716
4494
  $ref: "#/components/schemas/CountryCode"
3717
4495
  CtctDtls:
4496
+ description: |
4497
+ ContactDetails
4498
+ Set of elements used to indicate how to contact the party.
3718
4499
  $ref: "#/components/schemas/Contact4"
3719
4500
  example:
3720
4501
  Nm: John Doe
3721
4502
  PstlAdr:
3722
- Ctry: BE
3723
- AdrLine:
3724
- - Rue du Marché 45
3725
- - Brussels
3726
- - BE
4503
+ AdrTp: ADDR
4504
+ Dept: Dept
4505
+ SubDept: SubDept
4506
+ StrtNm: StrtNm
4507
+ BldgNb: BldgNb
4508
+ BldgNm: BldgNm
4509
+ Flr: Flr
4510
+ PstBx: PstBx
4511
+ Room: Room
4512
+ PstCd: PstCd
4513
+ TwnNm: TwnNm
4514
+ TwnLctnNm: TwnLctnNm
4515
+ DstrctNm: DstrctNm
4516
+ CtrySubDvsn: CtrySubDvsn
4517
+ Ctry: Ctry
4518
+ AdrLine: AdrLine
3727
4519
  Id:
3728
4520
  OrgId:
3729
- AnyBIC: CCCCUS33
4521
+ Othr:
4522
+ Id: 123
4523
+ SchmeNm:
4524
+ Prtry: DfspId
3730
4525
  CtryOfRes: BE
3731
4526
  CtctDtls:
3732
4527
  NmPrfx: Mr
@@ -3734,7 +4529,7 @@ components:
3734
4529
  PhneNb: +123-123-321
3735
4530
  MobNb: +123-123-321
3736
4531
  FaxNb: +123-123-321
3737
- EmailAdr: null
4532
+ EmailAdr: example@example.com
3738
4533
  PartyIdentification272:
3739
4534
  title: PartyIdentification272
3740
4535
  description: |
@@ -3742,14 +4537,36 @@ components:
3742
4537
  type: object
3743
4538
  properties:
3744
4539
  Nm:
4540
+ description: >
4541
+ Name
4542
+
4543
+ Name by which a party is known and which is usually used to identify
4544
+ that party.
3745
4545
  $ref: "#/components/schemas/Max140Text"
3746
4546
  PstlAdr:
4547
+ description: >
4548
+ Postal Address
4549
+
4550
+ Information that locates and identifies a specific address, as
4551
+ defined by postal services.
3747
4552
  $ref: "#/components/schemas/PostalAddress27"
3748
4553
  Id:
4554
+ description: |
4555
+ Identification
4556
+ Unique and unambiguous identification of a party.
3749
4557
  $ref: "#/components/schemas/Party52Choice"
3750
4558
  CtryOfRes:
4559
+ description: >
4560
+ Country of Residence
4561
+
4562
+ Country in which a person resides (the place of a person's home). In
4563
+ the case of a company, it is the country from which the affairs of
4564
+ that company are directed.
3751
4565
  $ref: "#/components/schemas/CountryCode"
3752
4566
  CtctDtls:
4567
+ description: |
4568
+ Contact Details
4569
+ Set of elements used to indicate how to contact the party.
3753
4570
  $ref: "#/components/schemas/Contact13"
3754
4571
  example:
3755
4572
  Nm: John Doe
@@ -3785,14 +4602,63 @@ components:
3785
4602
  type: object
3786
4603
  properties:
3787
4604
  InstrId:
4605
+ description: >
4606
+ InstructionIdentification
4607
+
4608
+ Definition: Unique identification, as assigned by an instructing
4609
+ party for an instructed party, to unambiguously identify the
4610
+ instruction.
4611
+
4612
+ Usage: The instruction identification is a point to point reference
4613
+ that can be used between the instructing party and the instructed
4614
+ party to refer to the individual instruction. It can be included in
4615
+ several messages related to the instruction.
3788
4616
  $ref: "#/components/schemas/Max35Text"
3789
4617
  EndToEndId:
4618
+ description: >
4619
+ EndToEndIdentification
4620
+
4621
+ Definition: Unique identification, as assigned by the initiating
4622
+ party, to unambiguously identify the transaction. This
4623
+ identification is passed on, unchanged, throughout the entire
4624
+ end-to-end chain.
4625
+
4626
+ Usage: The end-to-end identification can be used for reconciliation
4627
+ or to link tasks relating to the transaction. It can be included in
4628
+ several messages related to the transaction.
4629
+
4630
+ Usage: In case there are technical limitations to pass on multiple
4631
+ references, the end-to-end identification must be passed on
4632
+ throughout the entire end-to-end chain.
3790
4633
  $ref: "#/components/schemas/Max35Text"
3791
4634
  TxId:
4635
+ description: >
4636
+ TransactionIdentification
4637
+
4638
+ Definition: Unique identification, as assigned by the first
4639
+ instructing agent, to unambiguously identify the transaction that is
4640
+ passed on, unchanged, throughout the entire interbank chain.
4641
+
4642
+ Usage: The transaction identification can be used for
4643
+ reconciliation, tracking or to link tasks relating to the
4644
+ transaction on the interbank level.
4645
+
4646
+ Usage: The instructing agent has to make sure that the transaction
4647
+ identification is unique for a preagreed period.
3792
4648
  $ref: "#/components/schemas/Max35Text"
3793
4649
  UETR:
4650
+ description: >
4651
+ UETR
4652
+
4653
+ Universally unique identifier to provide an end-to-end reference of
4654
+ a payment transaction.
3794
4655
  $ref: "#/components/schemas/UUIDv4Identifier"
3795
4656
  ClrSysRef:
4657
+ description: >
4658
+ ClearingSystemReference
4659
+
4660
+ Unique reference, as assigned by a clearing system, to unambiguously
4661
+ identify the instruction.
3796
4662
  $ref: "#/components/schemas/Max35Text"
3797
4663
  required:
3798
4664
  - EndToEndId
@@ -3857,14 +4723,42 @@ components:
3857
4723
  type: object
3858
4724
  properties:
3859
4725
  InstrPrty:
4726
+ description: >
4727
+ InstructionPriority
4728
+
4729
+ Indicator of the urgency or order of importance that the instructing
4730
+ party would like the instructed party to apply to the processing of
4731
+ the instruction.
3860
4732
  $ref: "#/components/schemas/Priority2Code"
3861
4733
  ClrChanl:
4734
+ description: >
4735
+ ClearingChannel
4736
+
4737
+ Specifies the clearing channel to be used to process the payment
4738
+ instruction.
3862
4739
  $ref: "#/components/schemas/ClearingChannel2Code"
3863
4740
  SvcLvl:
4741
+ description: >
4742
+ ServiceLevel
4743
+
4744
+ Agreement under which or rules under which the transaction should be
4745
+ processed.
3864
4746
  $ref: "#/components/schemas/ServiceLevel8Choice"
3865
4747
  LclInstrm:
4748
+ description: >
4749
+ LocalInstrument
4750
+
4751
+ Definition: User community specific instrument.
4752
+
4753
+ Usage: This element is used to specify a local instrument, local
4754
+ clearing option and/or further qualify the service or service level.
3866
4755
  $ref: "#/components/schemas/LocalInstrument2Choice"
3867
4756
  CtgyPurp:
4757
+ description: >
4758
+ CategoryPurpose
4759
+
4760
+ Specifies the high level purpose of the instruction based on a set
4761
+ of pre-defined categories.
3868
4762
  $ref: "#/components/schemas/CategoryPurpose1Choice"
3869
4763
  example:
3870
4764
  InstrPrty: NORM
@@ -3887,8 +4781,16 @@ components:
3887
4781
  type: object
3888
4782
  properties:
3889
4783
  DtAndPlcOfBirth:
4784
+ description: |
4785
+ DateAndPlaceOfBirth
4786
+ Date and place of birth of a person.
3890
4787
  $ref: "#/components/schemas/DateAndPlaceOfBirth1"
3891
4788
  Othr:
4789
+ description: >
4790
+ Other
4791
+
4792
+ Unique identification of a person, as assigned by an institution,
4793
+ using an identification scheme.
3892
4794
  $ref: "#/components/schemas/GenericPersonIdentification1"
3893
4795
  example:
3894
4796
  DtAndPlcOfBirth:
@@ -3906,8 +4808,16 @@ components:
3906
4808
  type: object
3907
4809
  properties:
3908
4810
  DtAndPlcOfBirth:
4811
+ description: |
4812
+ DateAndPlaceOfBirth
4813
+ Date and place of birth of a person.
3909
4814
  $ref: "#/components/schemas/DateAndPlaceOfBirth1"
3910
4815
  Othr:
4816
+ description: >
4817
+ Other
4818
+
4819
+ Unique identification of a person, as assigned by an institution,
4820
+ using an identification scheme.
3911
4821
  $ref: "#/components/schemas/GenericPersonIdentification2"
3912
4822
  example:
3913
4823
  DtAndPlcOfBirth:
@@ -3925,8 +4835,16 @@ components:
3925
4835
  type: object
3926
4836
  properties:
3927
4837
  Cd:
4838
+ description: >
4839
+ Code
4840
+
4841
+ Name of the identification scheme, in a coded form as published in
4842
+ an external list
3928
4843
  $ref: "#/components/schemas/ExternalPersonIdentification1Code"
3929
4844
  Prtry:
4845
+ description: |
4846
+ Proprietary
4847
+ Name of the identification scheme, in a free text form
3930
4848
  $ref: "#/components/schemas/Max35Text"
3931
4849
  oneOf:
3932
4850
  - required:
@@ -4103,8 +5021,18 @@ components:
4103
5021
  type: object
4104
5022
  properties:
4105
5023
  Tp:
5024
+ description: |
5025
+ Type
5026
+
5027
+ Type of the proxy identification.
4106
5028
  $ref: "#/components/schemas/ProxyAccountType1Choice"
4107
5029
  Id:
5030
+ description: >
5031
+ Identification
5032
+
5033
+
5034
+ Identification used to indicate the account identification under
5035
+ another specified name.
4108
5036
  $ref: "#/components/schemas/Max2048Text"
4109
5037
  required:
4110
5038
  - Id
@@ -4116,11 +5044,23 @@ components:
4116
5044
  title: ProxyAccountType1Choice
4117
5045
  type: object
4118
5046
  description: |
4119
- NOTE: Unsure on description.
5047
+ ProxyAccountType1Choice
5048
+
5049
+ Specifies the scheme used for the identification of an account alias.
4120
5050
  properties:
4121
5051
  Cd:
5052
+ description: >
5053
+ Code
5054
+
5055
+
5056
+ Name of the identification scheme, in a coded form as published in
5057
+ an external list.
4122
5058
  $ref: "#/components/schemas/ExternalProxyAccountType1Code"
4123
5059
  Prtry:
5060
+ description: |
5061
+ Proprietary
5062
+
5063
+ Name of the identification scheme, in a free text form.
4124
5064
  $ref: "#/components/schemas/Max35Text"
4125
5065
  oneOf:
4126
5066
  - required:
@@ -4141,8 +5081,18 @@ components:
4141
5081
  type: object
4142
5082
  properties:
4143
5083
  Cd:
5084
+ description: >
5085
+ Code
5086
+
5087
+
5088
+ Underlying reason for the payment transaction, as published in an
5089
+ external purpose code list.
4144
5090
  $ref: "#/components/schemas/ExternalPurpose1Code"
4145
5091
  Prtry:
5092
+ description: |
5093
+ Proprietary
5094
+
5095
+ Purpose, in a proprietary form.
4146
5096
  $ref: "#/components/schemas/Max35Text"
4147
5097
  oneOf:
4148
5098
  - required:
@@ -4159,8 +5109,18 @@ components:
4159
5109
  type: object
4160
5110
  properties:
4161
5111
  Nm:
5112
+ description: |
5113
+ Name
5114
+
5115
+ Name of the entity requiring the regulatory reporting information.
4162
5116
  $ref: "#/components/schemas/Max140Text"
4163
5117
  Ctry:
5118
+ description: >
5119
+ Country
5120
+
5121
+
5122
+ Country of the entity that requires the regulatory reporting
5123
+ information.
4164
5124
  $ref: "#/components/schemas/CountryCode"
4165
5125
  example:
4166
5126
  Nm: Swiss National Bank
@@ -4172,11 +5132,31 @@ components:
4172
5132
  type: object
4173
5133
  properties:
4174
5134
  DbtCdtRptgInd:
5135
+ description: >
5136
+ DebitCreditReportingIndicator
5137
+
5138
+ Identifies whether the regulatory reporting information applies to
5139
+ the debit side, to the credit side or to both debit and credit sides
5140
+ of the transaction.
4175
5141
  $ref: "#/components/schemas/RegulatoryReportingType1Code"
4176
5142
  Authrty:
5143
+ description: |
5144
+ Authority
5145
+
5146
+ Entity requiring the regulatory reporting information.
4177
5147
  $ref: "#/components/schemas/RegulatoryAuthority2"
4178
5148
  Dtls:
4179
- $ref: "#/components/schemas/StructuredRegulatoryReporting3"
5149
+ description: >
5150
+ Details
5151
+
5152
+ Identifies whether the regulatory reporting information applies to
5153
+ the debit side, to the credit side or to both debit and credit sides
5154
+ of the transaction.
5155
+ anyOf:
5156
+ - $ref: "#/components/schemas/StructuredRegulatoryReporting3"
5157
+ - items:
5158
+ $ref: "#/components/schemas/StructuredRegulatoryReporting3"
5159
+ type: array
4180
5160
  example:
4181
5161
  DbtCdtRptgInd: CRED
4182
5162
  Authrty:
@@ -4204,8 +5184,18 @@ components:
4204
5184
  type: object
4205
5185
  properties:
4206
5186
  Cd:
5187
+ description: >
5188
+ Code
5189
+
5190
+ Specifies a pre-agreed service or level of service between the
5191
+ parties, as published in an external service level code list.
4207
5192
  $ref: "#/components/schemas/ExternalServiceLevel1Code"
4208
5193
  Prtry:
5194
+ description: >
5195
+ Proprietary
5196
+
5197
+ Specifies a pre-agreed service or level of service between the
5198
+ parties, as a proprietary code.
4209
5199
  $ref: "#/components/schemas/Max35Text"
4210
5200
  oneOf:
4211
5201
  - required:
@@ -4216,13 +5206,21 @@ components:
4216
5206
  Cd: SEPA
4217
5207
  SettlementInstruction15:
4218
5208
  title: SettlementInstruction15
4219
- description: |
4220
- NOTE: Unsure on description.
5209
+ description: >
5210
+ Specifies the details on how the settlement of the original
5211
+ transaction(s) between the
5212
+
5213
+ instructing agent and the instructed agent was completed.
4221
5214
  type: object
4222
5215
  properties:
4223
5216
  SttlmMtd:
5217
+ description: |
5218
+ SettlementMethod
5219
+ Method used to settle the (batch of) payment instructions.
4224
5220
  $ref: "#/components/schemas/SettlementMethod1Code"
4225
5221
  PmtTpInf:
5222
+ description: |
5223
+ PaymentTypeInformation
4226
5224
  $ref: "#/components/schemas/PaymentTypeInformation28"
4227
5225
  required:
4228
5226
  - SttlmMtd
@@ -4273,8 +5271,14 @@ components:
4273
5271
  type: object
4274
5272
  properties:
4275
5273
  Cd:
5274
+ description: |
5275
+ Code
5276
+ Reason for the status, as published in an external reason code list.
4276
5277
  $ref: "#/components/schemas/ExternalStatusReason1Code"
4277
5278
  Prtry:
5279
+ description: |
5280
+ Proprietary
5281
+ Reason for the status, in a proprietary form.
4278
5282
  $ref: "#/components/schemas/Max35Text"
4279
5283
  oneOf:
4280
5284
  - required:
@@ -4290,10 +5294,19 @@ components:
4290
5294
  type: object
4291
5295
  properties:
4292
5296
  Orgtr:
5297
+ description: |-
5298
+ Originator
5299
+ Party that issues the status.
4293
5300
  $ref: "#/components/schemas/PartyIdentification272"
4294
5301
  Rsn:
5302
+ description: |-
5303
+ Reason
5304
+ Specifies the reason for the status report.
4295
5305
  $ref: "#/components/schemas/StatusReason6Choice"
4296
5306
  AddtlInf:
5307
+ description: |-
5308
+ AdditionalInformation
5309
+ Additional information about the status report.
4297
5310
  $ref: "#/components/schemas/Max105Text"
4298
5311
  example:
4299
5312
  Orgtr:
@@ -4314,21 +5327,59 @@ components:
4314
5327
  StructuredRegulatoryReporting3:
4315
5328
  title: StructuredRegulatoryReporting3
4316
5329
  description: |
4317
- Unsure on description.
5330
+ StructuredRegulatoryReporting3
5331
+
5332
+ Information needed due to regulatory and statutory requirements.
4318
5333
  type: object
4319
5334
  properties:
4320
5335
  Tp:
5336
+ description: >
5337
+ Type
5338
+
5339
+
5340
+ Specifies the type of the information supplied in the regulatory
5341
+ reporting details.
4321
5342
  $ref: "#/components/schemas/Max35Text"
4322
5343
  Dt:
5344
+ description: |
5345
+ Date
5346
+
5347
+ Date related to the specified type of regulatory reporting details.
4323
5348
  $ref: "#/components/schemas/ISODate"
4324
5349
  Ctry:
5350
+ description: >
5351
+ Country
5352
+
5353
+
5354
+ Country related to the specified type of regulatory reporting
5355
+ details.
4325
5356
  $ref: "#/components/schemas/CountryCode"
4326
5357
  Cd:
5358
+ description: >
5359
+ Code
5360
+
5361
+ Specifies the nature, purpose, and reason for the transaction to be
5362
+ reported for regulatory and statutory requirements in a coded form.
4327
5363
  $ref: "#/components/schemas/Max10Text"
4328
5364
  Amt:
5365
+ description: >
5366
+ Amount
5367
+
5368
+
5369
+ Amount of money to be reported for regulatory and statutory
5370
+ requirements.
4329
5371
  $ref: "#/components/schemas/ActiveOrHistoricCurrencyAndAmount"
4330
5372
  Inf:
4331
- $ref: "#/components/schemas/Max35Text"
5373
+ description: >
5374
+ Information
5375
+
5376
+ Additional details that cater for specific domestic regulatory
5377
+ requirements.
5378
+ anyOf:
5379
+ - $ref: "#/components/schemas/Max35Text"
5380
+ - items:
5381
+ $ref: "#/components/schemas/Max35Text"
5382
+ type: array
4332
5383
  example:
4333
5384
  Tp: T1
4334
5385
  Dt: "2018-01-01"
@@ -4346,8 +5397,21 @@ components:
4346
5397
  type: object
4347
5398
  properties:
4348
5399
  PlcAndNm:
5400
+ description: >
5401
+ PlaceAndName
5402
+
5403
+ Unambiguous reference to the location where the supplementary data
5404
+ must be inserted in the message instance.
4349
5405
  $ref: "#/components/schemas/Max350Text"
4350
5406
  Envlp:
5407
+ description: >
5408
+ Envelope
5409
+
5410
+ Technical element wrapping the supplementary data.
5411
+
5412
+ Technical component that contains the validated supplementary data
5413
+ information. This technical envelope allows to segregate the
5414
+ supplementary data information from any other information.
4351
5415
  $ref: "#/components/schemas/SupplementaryDataEnvelope1"
4352
5416
  required:
4353
5417
  - Envlp
@@ -4358,8 +5422,12 @@ components:
4358
5422
  Prtry: Additional information
4359
5423
  SupplementaryDataEnvelope1:
4360
5424
  title: SupplementaryDataEnvelope1
4361
- description: |
4362
- Unsure on description.
5425
+ description: >
5426
+ SupplementaryDataEnvelope1
5427
+
5428
+ Technical component that contains the validated supplementary data
5429
+ information. This technical envelope allows to segregate the
5430
+ supplementary data information from any other information.
4363
5431
  type: object
4364
5432
  TaxAmount3:
4365
5433
  title: TaxAmount3
@@ -4368,13 +5436,37 @@ components:
4368
5436
  type: object
4369
5437
  properties:
4370
5438
  Rate:
5439
+ description: |
5440
+ Rate
5441
+
5442
+ Rate used to calculate the tax.
4371
5443
  $ref: "#/components/schemas/PercentageRate"
4372
5444
  TaxblBaseAmt:
5445
+ description: |
5446
+ TaxableBaseAmount
5447
+
5448
+ Amount of money on which the tax is based.
4373
5449
  $ref: "#/components/schemas/ActiveOrHistoricCurrencyAndAmount"
4374
5450
  TtlAmt:
5451
+ description: >
5452
+ TotalAmount
5453
+
5454
+
5455
+ Total amount that is the result of the calculation of the tax for
5456
+ the record.
4375
5457
  $ref: "#/components/schemas/ActiveOrHistoricCurrencyAndAmount"
4376
5458
  Dtls:
4377
- $ref: "#/components/schemas/TaxRecordDetails3"
5459
+ description: >
5460
+ Details
5461
+
5462
+
5463
+ Set of elements used to provide details on the tax period and
5464
+ amount.
5465
+ anyOf:
5466
+ - $ref: "#/components/schemas/TaxRecordDetails3"
5467
+ - items:
5468
+ $ref: "#/components/schemas/TaxRecordDetails3"
5469
+ type: array
4378
5470
  example:
4379
5471
  Rate: 0
4380
5472
  TaxblBaseAmt:
@@ -4398,8 +5490,18 @@ components:
4398
5490
  type: object
4399
5491
  properties:
4400
5492
  Titl:
5493
+ description: >
5494
+ Title
5495
+
5496
+
5497
+ Title or position of debtor or the debtor's authorised
5498
+ representative.
4401
5499
  $ref: "#/components/schemas/Max35Text"
4402
5500
  Nm:
5501
+ description: |
5502
+ Name
5503
+
5504
+ Name of the debtor or the debtor's authorised representative.
4403
5505
  $ref: "#/components/schemas/Max140Text"
4404
5506
  example:
4405
5507
  Titl: Mr
@@ -4413,27 +5515,81 @@ components:
4413
5515
  type: object
4414
5516
  properties:
4415
5517
  Cdtr:
5518
+ description: >
5519
+ Creditor
5520
+
5521
+
5522
+ Party on the credit side of the transaction to which the tax
5523
+ applies.
4416
5524
  $ref: "#/components/schemas/TaxParty1"
4417
5525
  Dbtr:
5526
+ description: |
5527
+ Debtor
5528
+
5529
+ Party on the debit side of the transaction to which the tax applies.
4418
5530
  $ref: "#/components/schemas/TaxParty2"
4419
5531
  UltmtDbtr:
5532
+ description: >
5533
+ UltimateDebtor
5534
+
5535
+
5536
+ Ultimate party that owes an amount of money to the (ultimate)
5537
+ creditor, in this case, to the taxing authority.
4420
5538
  $ref: "#/components/schemas/TaxParty2"
4421
5539
  AdmstnZone:
5540
+ description: |
5541
+ AdministrationZone
5542
+
5543
+ Territorial part of a country to which the tax payment is related.
4422
5544
  $ref: "#/components/schemas/Max35Text"
4423
5545
  RefNb:
5546
+ description: |
5547
+ ReferenceNumber
5548
+
5549
+ Tax reference information that is specific to a taxing agency.
4424
5550
  $ref: "#/components/schemas/Max140Text"
4425
5551
  Mtd:
5552
+ description: >
5553
+ Method
5554
+
5555
+
5556
+ Method used to indicate the underlying business or how the tax is
5557
+ paid.
4426
5558
  $ref: "#/components/schemas/Max35Text"
4427
5559
  TtlTaxblBaseAmt:
5560
+ description: |
5561
+ TotalTaxableBaseAmount
5562
+
5563
+ Total amount of money on which the tax is based.
4428
5564
  $ref: "#/components/schemas/ActiveOrHistoricCurrencyAndAmount"
4429
5565
  TtlTaxAmt:
5566
+ description: |
5567
+ TotalTaxAmount
5568
+
5569
+ Total amount of money as result of the calculation of the tax.
4430
5570
  $ref: "#/components/schemas/ActiveOrHistoricCurrencyAndAmount"
4431
5571
  Dt:
5572
+ description: |
5573
+ Date
5574
+
5575
+ Date by which tax is due.
4432
5576
  $ref: "#/components/schemas/ISODate"
4433
5577
  SeqNb:
5578
+ description: |
5579
+ SequenceNumber
5580
+
5581
+ Sequential number of the tax report
4434
5582
  $ref: "#/components/schemas/Number"
4435
5583
  Rcrd:
4436
- $ref: "#/components/schemas/TaxRecord3"
5584
+ description: |
5585
+ Record
5586
+
5587
+ Details of the tax record.
5588
+ anyOf:
5589
+ - $ref: "#/components/schemas/TaxRecord3"
5590
+ - items:
5591
+ $ref: "#/components/schemas/TaxRecord3"
5592
+ type: array
4437
5593
  example:
4438
5594
  Cdtr:
4439
5595
  Titl: Mr
@@ -4470,10 +5626,24 @@ components:
4470
5626
  type: object
4471
5627
  properties:
4472
5628
  TaxId:
5629
+ description: |
5630
+ TaxIdentification
5631
+
5632
+ Tax identification number of the creditor.
4473
5633
  $ref: "#/components/schemas/Max35Text"
4474
5634
  RegnId:
5635
+ description: >
5636
+ RegistrationIdentification
5637
+
5638
+
5639
+ Unique identification, as assigned by an organisation, to
5640
+ unambiguously identify a party.
4475
5641
  $ref: "#/components/schemas/Max35Text"
4476
5642
  TaxTp:
5643
+ description: |
5644
+ TaxType
5645
+
5646
+ Type of tax payer.
4477
5647
  $ref: "#/components/schemas/Max35Text"
4478
5648
  example:
4479
5649
  TaxId: 123456789
@@ -4486,12 +5656,30 @@ components:
4486
5656
  type: object
4487
5657
  properties:
4488
5658
  TaxId:
5659
+ description: |
5660
+ TaxIdentification
5661
+
5662
+ Tax identification number of the debtor.
4489
5663
  $ref: "#/components/schemas/Max35Text"
4490
5664
  RegnId:
5665
+ description: >
5666
+ RegistrationIdentification
5667
+
5668
+
5669
+ Unique identification, as assigned by an organisation, to
5670
+ unambiguously identify a party.
4491
5671
  $ref: "#/components/schemas/Max35Text"
4492
5672
  TaxTp:
5673
+ description: |
5674
+ TaxType
5675
+
5676
+ Type of tax payer.
4493
5677
  $ref: "#/components/schemas/Max35Text"
4494
5678
  Authstn:
5679
+ description: |
5680
+ Authorisation
5681
+
5682
+ Details of the authorised tax paying party.
4495
5683
  $ref: "#/components/schemas/TaxAuthorisation1"
4496
5684
  example:
4497
5685
  TaxId: 123456789
@@ -4506,12 +5694,26 @@ components:
4506
5694
  Period of time details related to the tax payment.
4507
5695
  type: object
4508
5696
  properties:
4509
- Yr:
4510
- $ref: "#/components/schemas/ISOYear"
4511
- Tp:
4512
- $ref: "#/components/schemas/TaxRecordPeriod1Code"
4513
5697
  FrToDt:
4514
5698
  $ref: "#/components/schemas/DatePeriod2"
5699
+ description: >
5700
+ FromToDate
5701
+
5702
+
5703
+ Range of time between a start date and an end date for which the tax
5704
+ report is provided.
5705
+ Tp:
5706
+ $ref: "#/components/schemas/TaxRecordPeriod1Code"
5707
+ description: |
5708
+ Type
5709
+
5710
+ Identification of the period related to the tax payment.
5711
+ Yr:
5712
+ $ref: "#/components/schemas/ISOYear"
5713
+ description: |
5714
+ Year
5715
+
5716
+ Year related to the tax payment.
4515
5717
  example:
4516
5718
  Yr: 2020
4517
5719
  Tp: MM01
@@ -4524,24 +5726,70 @@ components:
4524
5726
  Set of elements used to define the tax record.
4525
5727
  type: object
4526
5728
  properties:
4527
- Tp:
5729
+ AddtlInf:
5730
+ $ref: "#/components/schemas/Max140Text"
5731
+ description: |
5732
+ AdditionalInformation
5733
+
5734
+ Further details of the tax record.
5735
+ CertId:
4528
5736
  $ref: "#/components/schemas/Max35Text"
5737
+ description: >
5738
+ CertificateIdentification
5739
+
5740
+
5741
+ Identification number of the tax report as assigned by the taxing
5742
+ authority.
4529
5743
  Ctgy:
4530
5744
  $ref: "#/components/schemas/Max35Text"
5745
+ description: |
5746
+ Category
5747
+
5748
+ Specifies the tax code as published by the tax authority.
4531
5749
  CtgyDtls:
4532
5750
  $ref: "#/components/schemas/Max35Text"
5751
+ description: |
5752
+ CategoryDetails
5753
+
5754
+ Provides further details of the category tax code.
4533
5755
  DbtrSts:
4534
5756
  $ref: "#/components/schemas/Max35Text"
4535
- CertId:
4536
- $ref: "#/components/schemas/Max35Text"
5757
+ description: >
5758
+ DebtorStatus
5759
+
5760
+
5761
+ Code provided by local authority to identify the status of the party
5762
+ that has drawn up the settlement document.
4537
5763
  FrmsCd:
4538
5764
  $ref: "#/components/schemas/Max35Text"
5765
+ description: >
5766
+ FormsCode
5767
+
5768
+
5769
+ Identifies, in a coded form, on which template the tax report is to
5770
+ be provided.
4539
5771
  Prd:
4540
5772
  $ref: "#/components/schemas/TaxPeriod3"
5773
+ description: >
5774
+ Period
5775
+
5776
+
5777
+ Set of elements used to provide details on the period of time
5778
+ related to the tax payment.
4541
5779
  TaxAmt:
4542
5780
  $ref: "#/components/schemas/TaxAmount3"
4543
- AddtlInf:
4544
- $ref: "#/components/schemas/Max140Text"
5781
+ description: >
5782
+ TaxAmount
5783
+
5784
+
5785
+ Set of elements used to provide information on the amount of the tax
5786
+ record.
5787
+ Tp:
5788
+ $ref: "#/components/schemas/Max35Text"
5789
+ description: |
5790
+ Type
5791
+
5792
+ High level code to identify the type of tax details.
4545
5793
  example:
4546
5794
  Tp: VAT
4547
5795
  Ctgy: A
@@ -4564,8 +5812,18 @@ components:
4564
5812
  type: object
4565
5813
  properties:
4566
5814
  Prd:
5815
+ description: >
5816
+ Period
5817
+
5818
+
5819
+ Set of elements used to provide details on the period of time
5820
+ related to the tax payment.
4567
5821
  $ref: "#/components/schemas/TaxPeriod3"
4568
5822
  Amt:
5823
+ description: |
5824
+ Amount
5825
+
5826
+ Underlying tax amount related to the specified period.
4569
5827
  $ref: "#/components/schemas/ActiveOrHistoricCurrencyAndAmount"
4570
5828
  required:
4571
5829
  - Amt
@@ -4688,8 +5946,18 @@ components:
4688
5946
  type: object
4689
5947
  properties:
4690
5948
  Cd:
5949
+ description: >
5950
+ Code
5951
+
5952
+ Reason why the verified identification information is incorrect, as
5953
+ published in an external reason code list.
4691
5954
  $ref: "#/components/schemas/ExternalVerificationReason1Code"
4692
5955
  Prtry:
5956
+ description: >
5957
+ Proprietary
5958
+
5959
+ Reason why the verified identification information is incorrect, in
5960
+ a free text form.
4693
5961
  $ref: "#/components/schemas/Max35Text"
4694
5962
  oneOf:
4695
5963
  - required:
@@ -4703,31 +5971,81 @@ components:
4703
5971
  type: object
4704
5972
  properties:
4705
5973
  OrgnlId:
5974
+ description: >
5975
+ OriginalIdentification
5976
+
5977
+ Unique identification, as assigned by a sending party, to
5978
+ unambiguously identify the party and account identification
5979
+ information group within the original message.
4706
5980
  $ref: "#/components/schemas/Max35Text"
4707
5981
  Vrfctn:
5982
+ description: >
5983
+ Verification
5984
+
5985
+ Identifies whether the party and/or account information received is
5986
+ correct. Boolean value.
4708
5987
  $ref: "#/components/schemas/IdentificationVerificationIndicator"
4709
5988
  Rsn:
5989
+ description: >
5990
+ Reason.
5991
+
5992
+ Specifies the reason why the verified identification information is
5993
+ incorrect.
4710
5994
  $ref: "#/components/schemas/VerificationReason1Choice"
4711
5995
  OrgnlPtyAndAcctId:
5996
+ description: >
5997
+ OriginalPartyAndAccountIdentification
5998
+
5999
+ Provides party and/or account identification information as given in
6000
+ the original message.
4712
6001
  $ref: "#/components/schemas/IdentificationInformation4"
4713
6002
  UpdtdPtyAndAcctId:
6003
+ description: |
6004
+ UpdatedPartyAndAccountIdentification
6005
+ Provides party and/or account identification information.
4714
6006
  $ref: "#/components/schemas/IdentificationInformation4"
4715
6007
  required:
4716
6008
  - OrgnlId
4717
6009
  - Vrfctn
4718
6010
  example:
4719
- OrgnlId: 123456789
6011
+ OrgnlId: 1.2345678901234568e+33
4720
6012
  Vrfctn: true
4721
- Rsn:
4722
- Cd: AGNT
4723
6013
  OrgnlPtyAndAcctId:
4724
- Id: 123456789
4725
- SchmeNm:
4726
- Cd: CCPT
6014
+ Nm: John Doe
6015
+ PstlAdr:
6016
+ AdrTp: ADDR
6017
+ Dept: Dept
6018
+ SubDept: SubDept
6019
+ StrtNm: 1234 Elm St
6020
+ BldgNb: 1234
6021
+ PstCd: 12345
6022
+ TwnNm: Anytown
6023
+ CtrySubDvsn: CA
6024
+ Ctry: US
6025
+ Id:
6026
+ OrgId:
6027
+ AnyBIC: ABCDUS33
6028
+ Othr:
6029
+ Id: 123456789
6030
+ Issr: ABA
4727
6031
  UpdtdPtyAndAcctId:
4728
- Id: 123456789
4729
- SchmeNm:
4730
- Cd: CCPT
6032
+ Nm: John Doe
6033
+ PstlAdr:
6034
+ AdrTp: ADDR
6035
+ Dept: Dept
6036
+ SubDept: SubDept
6037
+ StrtNm: 1234 Elm St
6038
+ BldgNb: 1234
6039
+ PstCd: 12345
6040
+ TwnNm: Anytown
6041
+ CtrySubDvsn: CA
6042
+ Ctry: US
6043
+ Id:
6044
+ OrgId:
6045
+ AnyBIC: ABCDUS33
6046
+ Othr:
6047
+ Id: 123456789
6048
+ Issr: ABA
4731
6049
  hexBinary:
4732
6050
  title: hexBinary
4733
6051
  type: string