@mojaloop/api-snippets 17.6.0 → 17.7.0-snapshot.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 (108) 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/docs/fspiop-rest-v2.0-openapi3-snippets.yaml +5 -7
  5. package/docs/sdk-scheme-adapter-backend-v2_1_0-openapi3-snippets.yaml +13 -13
  6. package/docs/sdk-scheme-adapter-outbound-v2_1_0-openapi3-snippets.yaml +2 -2
  7. package/fspiop/v2_0/openapi3/components/schemas/CorrelationId.yaml +5 -6
  8. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/AccountIdentification4Choice.yaml +12 -0
  9. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/AccountSchemeName1Choice.yaml +8 -0
  10. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ActiveCurrencyAndAmount.yaml +4 -0
  11. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ActiveOrHistoricCurrencyAndAmount.yaml +4 -0
  12. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/AddressType2Code.yaml +1 -0
  13. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/AddressType3Choice.yaml +8 -0
  14. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/BranchAndFinancialInstitutionIdentification6.yaml +12 -0
  15. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/BranchAndFinancialInstitutionIdentification8.yaml +22 -8
  16. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/BranchData3.yaml +16 -0
  17. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/BranchData5.yaml +28 -6
  18. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/CashAccount40.yaml +29 -0
  19. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/CashAccountType2Choice.yaml +8 -0
  20. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/CategoryPurpose1Choice.yaml +8 -0
  21. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ChargeType3Choice.yaml +12 -1
  22. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Charges16.yaml +14 -0
  23. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ClearingSystemIdentification2Choice.yaml +9 -0
  24. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ClearingSystemMemberIdentification2.yaml +9 -0
  25. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Contact13.yaml +53 -0
  26. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Contact4.yaml +48 -0
  27. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/CountryCode.yaml +3 -0
  28. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/CreditTransferTransaction67.yaml +78 -0
  29. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/CreditTransferTransaction68.yaml +48 -0
  30. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/DateAndPlaceOfBirth1.yaml +16 -0
  31. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/DatePeriod2.yaml +10 -2
  32. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Execute_FIToFICustomerCreditTransferV13.yaml +46 -38
  33. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/FinancialIdentificationSchemeName1Choice.yaml +8 -0
  34. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/FinancialInstitutionIdentification18.yaml +48 -7
  35. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/FinancialInstitutionIdentification23.yaml +48 -7
  36. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/FxRequest_FICreditTransferProposal.yaml +71 -69
  37. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/FxResponse_FICreditTransferConfirmation.yaml +8 -0
  38. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Fxecute_FinancialInstitutionCreditTransferV12.yaml +9 -1
  39. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericAccountIdentification1.yaml +12 -0
  40. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericFinancialIdentification1.yaml +12 -0
  41. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericIdentification3.yaml +9 -0
  42. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericIdentification30.yaml +12 -0
  43. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericOrganisationIdentification1.yaml +12 -0
  44. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericOrganisationIdentification3.yaml +12 -0
  45. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericPersonIdentification1.yaml +12 -0
  46. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericPersonIdentification2.yaml +12 -0
  47. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/GetPartiesError_IdentificationVerificationReportV03.yaml +13 -0
  48. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/GetParties_IdentificationVerificationReportV03.yaml +60 -40
  49. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/GroupHeader120.yaml +19 -0
  50. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/IdentificationAssignment3.yaml +14 -0
  51. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/IdentificationInformation4.yaml +12 -0
  52. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/IdentificationVerificationIndicator.yaml +5 -0
  53. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/InstructionForCreditorAgent3.yaml +10 -0
  54. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/InstructionForNextAgent1.yaml +10 -0
  55. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/LocalInstrument2Choice.yaml +8 -0
  56. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/OrganisationIdentification29.yaml +12 -0
  57. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/OrganisationIdentification39.yaml +12 -0
  58. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/OrganisationIdentificationSchemeName1Choice.yaml +8 -0
  59. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/OtherContact1.yaml +8 -0
  60. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/PacsStatus_FIToFIPaymentStatusReportV15.yaml +16 -65
  61. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Party38Choice.yaml +8 -0
  62. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Party40Choice.yaml +9 -1
  63. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Party52Choice.yaml +9 -1
  64. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/PartyIdentification135.yaml +43 -7
  65. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/PartyIdentification272.yaml +21 -0
  66. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/PaymentIdentification13.yaml +39 -0
  67. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/PaymentTypeInformation28.yaml +24 -0
  68. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/PersonIdentification13.yaml +8 -0
  69. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/PersonIdentification18.yaml +8 -0
  70. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/PersonIdentificationSchemeName1Choice.yaml +8 -0
  71. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ProxyAccountIdentification1.yaml +8 -0
  72. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ProxyAccountType1Choice.yaml +11 -1
  73. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Purpose2Choice.yaml +8 -0
  74. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/RegulatoryAuthority2.yaml +8 -0
  75. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/RegulatoryReporting3.yaml +19 -1
  76. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ServiceLevel8Choice.yaml +9 -0
  77. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/SettlementInstruction15.yaml +8 -1
  78. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/StatusReason6Choice.yaml +8 -0
  79. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/StatusReasonInformation14.yaml +12 -0
  80. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/StructuredRegulatoryReporting3.yaml +32 -2
  81. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/SupplementaryData1.yaml +12 -0
  82. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/SupplementaryDataEnvelope1.yaml +5 -2
  83. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxAmount3.yaml +21 -1
  84. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxAuthorisation1.yaml +8 -0
  85. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxData1.yaml +49 -1
  86. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxParty1.yaml +12 -0
  87. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxParty2.yaml +16 -0
  88. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxPeriod3.yaml +16 -4
  89. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxRecord3.yaml +41 -5
  90. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxRecordDetails3.yaml +8 -0
  91. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/VerificationReason1Choice.yaml +9 -0
  92. package/fspiop/v2_0_ISO20022/openapi3/components/schemas/VerificationReport4.yaml +57 -9
  93. package/fspiop/v2_0_ISO20022/openapi3/openapi.yaml +1 -1
  94. package/lib/fspiop/v2_0/json-schemas.json +78 -78
  95. package/lib/fspiop/v2_0/openapi.d.ts +1 -1
  96. package/lib/fspiop/v2_0_ISO20022/json-schemas.json +19225 -8772
  97. package/lib/fspiop/v2_0_ISO20022/openapi.d.ts +1285 -370
  98. package/lib/fspiop/v2_0_ISO20022/schemas.d.ts +17496 -7191
  99. package/lib/sdk-scheme-adapter/v2_1_0/backend/json-schemas.json +123 -123
  100. package/lib/sdk-scheme-adapter/v2_1_0/backend/openapi.d.ts +6 -6
  101. package/lib/sdk-scheme-adapter/v2_1_0/outbound/json-schemas.json +144 -144
  102. package/lib/sdk-scheme-adapter/v2_1_0/outbound/openapi.d.ts +1 -1
  103. package/package.json +8 -8
  104. package/sdk-bulk.yaml +5 -9
  105. package/sdk-scheme-adapter/v2_1_0/backend/openapi.yaml +11 -11
  106. package/sdk-scheme-adapter/v2_1_0/components/schemas/CorrelationId.yaml +5 -6
  107. package/thirdparty/v1_0/openapi3/thirdparty-dfsp-api.yaml +11 -8
  108. package/thirdparty/v1_0/openapi3/thirdparty-pisp-api.yaml +11 -8
@@ -518,7 +518,13 @@ export interface components {
518
518
  * }
519
519
  */
520
520
  AccountIdentification4Choice: {
521
+ /** @description IBAN
522
+ * International Bank Account Number (IBAN) - identifier used internationally by financial institutions to uniquely identify the account of a customer. Further specifications of the format and content of the IBAN can be found in the standard ISO 13616 "Banking and related financial services - International Bank Account Number (IBAN)" version 1997-10-01, or later revisions.
523
+ * */
521
524
  IBAN?: components["schemas"]["IBAN2007Identifier"];
525
+ /** @description Other
526
+ * Unique identification of an account, as assigned by the account servicer, using an identification scheme.
527
+ * */
522
528
  Othr?: components["schemas"]["GenericAccountIdentification1"];
523
529
  } & (unknown | unknown);
524
530
  /**
@@ -530,7 +536,13 @@ export interface components {
530
536
  * }
531
537
  */
532
538
  AccountSchemeName1Choice: {
539
+ /** @description Code
540
+ * Name of the identification scheme, in a coded form as published in an external list.
541
+ * */
533
542
  Cd?: components["schemas"]["ExternalAccountIdentification1Code"];
543
+ /** @description Proprietary
544
+ * Name of the identification scheme, in a free text form.
545
+ * */
534
546
  Prtry?: components["schemas"]["Max35Text"];
535
547
  } & (unknown | unknown);
536
548
  /**
@@ -544,6 +556,9 @@ export interface components {
544
556
  */
545
557
  ActiveCurrencyAndAmount: {
546
558
  ActiveCurrencyAndAmount: components["schemas"]["ActiveCurrencyAndAmount_SimpleType"];
559
+ /** @description Currency
560
+ * Identification of the currency in which the account is held.
561
+ * */
547
562
  Ccy: components["schemas"]["ActiveCurrencyCode"];
548
563
  };
549
564
  /**
@@ -577,6 +592,9 @@ export interface components {
577
592
  */
578
593
  ActiveOrHistoricCurrencyAndAmount: {
579
594
  ActiveOrHistoricCurrencyAndAmount: components["schemas"]["ActiveOrHistoricCurrencyAndAmount_SimpleType"];
595
+ /** @description Currency
596
+ * Identification of the currency in which the account is held.
597
+ * */
580
598
  Ccy: components["schemas"]["ActiveOrHistoricCurrencyCode"];
581
599
  };
582
600
  /**
@@ -593,6 +611,7 @@ export interface components {
593
611
  ActiveOrHistoricCurrencyCode: string;
594
612
  /**
595
613
  * @description AddressType2Code
614
+ *
596
615
  * Specifies the type of address.
597
616
  *
598
617
  * @example ADDR
@@ -608,7 +627,13 @@ export interface components {
608
627
  * }
609
628
  */
610
629
  AddressType3Choice: {
630
+ /** @description Code
631
+ * Type of address expressed as a code.
632
+ * */
611
633
  Cd?: components["schemas"]["AddressType2Code"];
634
+ /** @description Proprietary
635
+ * Type of address expressed as a proprietary code.
636
+ * */
612
637
  Prtry?: components["schemas"]["GenericIdentification30"];
613
638
  } & (unknown | unknown);
614
639
  /**
@@ -666,7 +691,14 @@ export interface components {
666
691
  * }
667
692
  */
668
693
  BranchAndFinancialInstitutionIdentification6: {
694
+ /** @description FinancialInstitutionIdentification
695
+ * Unique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme.
696
+ * */
669
697
  FinInstnId: components["schemas"]["FinancialInstitutionIdentification18"];
698
+ /** @description BranchIdentification
699
+ * Definition: Identifies a specific branch of a financial institution.
700
+ * Usage: This component should be used in case the identification information in the financial institution component does not provide identification up to branch level.
701
+ * */
670
702
  BrnchId?: components["schemas"]["BranchData3"];
671
703
  };
672
704
  /**
@@ -675,24 +707,35 @@ export interface components {
675
707
  *
676
708
  * @example {
677
709
  * "FinInstnId": {
678
- * "BICFI": "BUKBGB22"
710
+ * "BICFI": "J5BMVH7D"
679
711
  * },
680
712
  * "BrnchId": {
681
- * "Id": 12345,
682
- * "Nm": "Oxford Street Branch",
713
+ * "Id": 123,
714
+ * "Nm": "Name",
683
715
  * "PstlAdr": {
684
- * "Ctry": "GB",
685
- * "AdrLine": [
686
- * "1 Oxford Street",
687
- * "London",
688
- * "UK"
689
- * ]
716
+ * "AdrTp": "ADDR",
717
+ * "Dept": "Department",
718
+ * "SubDept": "Sub department",
719
+ * "StrtNm": "Street name",
720
+ * "BldgNb": "Building number",
721
+ * "PstCd": "Post code",
722
+ * "TwnNm": "Town name",
723
+ * "CtrySubDvsn": "Country subdivision",
724
+ * "Ctry": "Country",
725
+ * "AdrLine": "Address line"
690
726
  * }
691
727
  * }
692
728
  * }
693
729
  */
694
730
  BranchAndFinancialInstitutionIdentification8: {
731
+ /** @description FinancialInstitutionIdentification
732
+ * Unique and unambiguous identification of a financial institution or a branch of a financial institution.
733
+ * */
695
734
  FinInstnId: components["schemas"]["FinancialInstitutionIdentification23"];
735
+ /** @description BranchIdentification
736
+ *
737
+ * Identifies a specific branch of a financial institution.
738
+ * */
696
739
  BrnchId?: components["schemas"]["BranchData5"];
697
740
  };
698
741
  /**
@@ -717,9 +760,21 @@ export interface components {
717
760
  * }
718
761
  */
719
762
  BranchData3: {
763
+ /** @description Identification
764
+ * Unique and unambiguous identification of a branch of a financial institution.
765
+ * */
720
766
  Id?: components["schemas"]["Max35Text"];
767
+ /** @description Legal Entity Identifier
768
+ * Legal entity identification for the branch of the financial institution.
769
+ * */
721
770
  LEI?: components["schemas"]["LEIIdentifier"];
771
+ /** @description Name
772
+ * Name by which an agent is known and which is usually used to identify that agent.
773
+ * */
722
774
  Nm?: components["schemas"]["Max140Text"];
775
+ /** @description Postal Address
776
+ * Information that locates and identifies a specific address, as defined by postal services.
777
+ * */
723
778
  PstlAdr?: components["schemas"]["PostalAddress24"];
724
779
  };
725
780
  /**
@@ -728,21 +783,38 @@ export interface components {
728
783
  *
729
784
  * @example {
730
785
  * "Id": 123,
731
- * "Nm": "Oxford Street Branch",
786
+ * "LEI": 123,
787
+ * "Nm": "Name",
732
788
  * "PstlAdr": {
733
- * "Ctry": "GB",
734
- * "AdrLine": [
735
- * "1 Oxford Street",
736
- * "London",
737
- * "UK"
738
- * ]
789
+ * "AdrTp": "ADDR",
790
+ * "Dept": "Department",
791
+ * "SubDept": "Sub department",
792
+ * "StrtNm": "Street name",
793
+ * "BldgNb": "Building number",
794
+ * "PstCd": "Post code",
795
+ * "TwnNm": "Town name",
796
+ * "CtrySubDvsn": "Country subdivision",
797
+ * "Ctry": "Country",
798
+ * "AdrLine": "Address line"
739
799
  * }
740
800
  * }
741
801
  */
742
802
  BranchData5: {
803
+ /** @description Identification
804
+ * Unique and unambiguous identification of a branch of a financial institution.
805
+ * */
743
806
  Id?: components["schemas"]["Max35Text"];
807
+ /** @description LEI
808
+ * Legal entity identification for the branch of the financial institution.
809
+ * */
744
810
  LEI?: components["schemas"]["LEIIdentifier"];
811
+ /** @description Name
812
+ * Name by which an agent is known and which is usually used to identify that agent.
813
+ * */
745
814
  Nm?: components["schemas"]["Max140Text"];
815
+ /** @description PostalAddress
816
+ * Information that locates and identifies a specific address, as defined by postal services.
817
+ * */
746
818
  PstlAdr?: components["schemas"]["PostalAddress27"];
747
819
  };
748
820
  /**
@@ -764,10 +836,27 @@ export interface components {
764
836
  * }
765
837
  */
766
838
  CashAccount40: {
839
+ /** @description Identification
840
+ * Unique and unambiguous identification for the account between the account owner and the account servicer.
841
+ * */
767
842
  Id?: components["schemas"]["AccountIdentification4Choice"];
843
+ /** @description Type
844
+ * Specifies the nature, or use of the account.
845
+ * */
768
846
  Tp?: components["schemas"]["CashAccountType2Choice"];
847
+ /** @description Currency
848
+ * Definition: Identification of the currency in which the account is held.
849
+ * Usage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.
850
+ * */
769
851
  Ccy?: components["schemas"]["ActiveOrHistoricCurrencyCode"];
852
+ /** @description Name
853
+ * Definition: Name of the account, as assigned by the account servicing institution, in agreement with the account owner in order to provide an additional means of identification of the account.
854
+ * Usage: The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner's identity and the account number.
855
+ * */
770
856
  Nm?: components["schemas"]["Max70Text"];
857
+ /** @description Proxy
858
+ * Specifies an alternate assumed name for the identification of the account.
859
+ * */
771
860
  Prxy?: components["schemas"]["ProxyAccountIdentification1"];
772
861
  };
773
862
  /**
@@ -779,7 +868,13 @@ export interface components {
779
868
  * }
780
869
  */
781
870
  CashAccountType2Choice: {
871
+ /** @description Code
872
+ * Account type, in a coded form.
873
+ * */
782
874
  Cd?: components["schemas"]["ExternalCashAccountType1Code"];
875
+ /** @description Proprietary
876
+ * Nature or use of the account in a proprietary form.
877
+ * */
783
878
  Prtry?: components["schemas"]["Max35Text"];
784
879
  } & (unknown | unknown);
785
880
  /**
@@ -791,7 +886,13 @@ export interface components {
791
886
  * }
792
887
  */
793
888
  CategoryPurpose1Choice: {
889
+ /** @description Code
890
+ * Category purpose, as published in an external category purpose code list.
891
+ * */
794
892
  Cd?: components["schemas"]["ExternalCategoryPurpose1Code"];
893
+ /** @description Proprietary
894
+ * Category purpose, in a proprietary form.
895
+ * */
795
896
  Prtry?: components["schemas"]["Max35Text"];
796
897
  } & (unknown | unknown);
797
898
  /**
@@ -808,19 +909,29 @@ export interface components {
808
909
  ChargeBearerType1Code: "DEBT" | "CRED" | "SHAR" | "SLEV";
809
910
  /**
810
911
  * ChargeType3Choice
811
- * @description ChargeType3Choice Specifies the type of charge.
912
+ * @description ChargeType3Choice
913
+ * Specifies the type of charge.
914
+ *
812
915
  * @example {
813
916
  * "Cd": "CASH"
814
917
  * }
815
918
  */
816
919
  ChargeType3Choice: {
920
+ /** @description Code
921
+ * Charge type, in a coded form.
922
+ * */
817
923
  Cd?: components["schemas"]["ExternalChargeType1Code"];
924
+ /** @description Proprietary
925
+ * Type of charge in a proprietary form, as defined by the issuer.
926
+ * */
818
927
  Prtry?: components["schemas"]["GenericIdentification3"];
819
928
  } & (unknown | unknown);
820
929
  /**
821
930
  * Charges16
822
931
  * @description NOTE: Unsure on description.
823
932
  *
933
+ * Seemingly a generic schema for charges, with an amount, agent, and type.
934
+ *
824
935
  * @example {
825
936
  * "Amt": {
826
937
  * "ActiveOrHistoricCurrencyAndAmount": 123.45,
@@ -840,8 +951,19 @@ export interface components {
840
951
  * }
841
952
  */
842
953
  Charges16: {
954
+ /** @description Amount
955
+ *
956
+ * Transaction charges to be paid by the charge bearer.
957
+ * */
843
958
  Amt: components["schemas"]["ActiveOrHistoricCurrencyAndAmount"];
959
+ /** @description Agent
960
+ * Agent that takes the transaction charges or to which the transaction charges are due.
961
+ * */
844
962
  Agt: components["schemas"]["BranchAndFinancialInstitutionIdentification8"];
963
+ /** @description Type
964
+ *
965
+ * Defines the type of charges.
966
+ * */
845
967
  Tp?: components["schemas"]["ChargeType3Choice"];
846
968
  };
847
969
  /**
@@ -865,7 +987,13 @@ export interface components {
865
987
  * }
866
988
  */
867
989
  ClearingSystemIdentification2Choice: {
990
+ /** @description Code
991
+ * Identification of a member of a clearing system
992
+ * */
868
993
  Cd?: components["schemas"]["ExternalClearingSystemIdentification1Code"];
994
+ /** @description Proprietary
995
+ * Identification code for a clearing system, that has not yet been identified in the list of clearing systems.
996
+ * */
869
997
  Prtry?: components["schemas"]["Max35Text"];
870
998
  } & (unknown | unknown);
871
999
  /**
@@ -880,7 +1008,13 @@ export interface components {
880
1008
  * }
881
1009
  */
882
1010
  ClearingSystemMemberIdentification2: {
1011
+ /** @description ClearingSystemIdentification.
1012
+ * Specification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed.
1013
+ * */
883
1014
  ClrSysId?: components["schemas"]["ClearingSystemIdentification2Choice"];
1015
+ /** @description MemberIdentification.
1016
+ * Identification of a member of a clearing system.
1017
+ * */
884
1018
  MmbId: components["schemas"]["Max35Text"];
885
1019
  };
886
1020
  /**
@@ -898,18 +1032,57 @@ export interface components {
898
1032
  * }
899
1033
  */
900
1034
  Contact13: {
1035
+ /** @description NamePrefix
1036
+ * Specifies the terms used to formally address a person.
1037
+ * */
901
1038
  NmPrfx?: components["schemas"]["NamePrefix2Code"];
1039
+ /** @description Name
1040
+ * Name by which a party is known and which is usually used to identify that party.
1041
+ * */
902
1042
  Nm?: components["schemas"]["Max140Text"];
1043
+ /** @description PhoneNumber
1044
+ * Collection of information that identifies a phone number, as defined by telecom services.
1045
+ * */
903
1046
  PhneNb?: components["schemas"]["PhoneNumber"];
1047
+ /** @description MobilePhoneNumber
1048
+ * Collection of information that identifies a mobile phone number, as defined by telecom services.
1049
+ * */
904
1050
  MobNb?: components["schemas"]["PhoneNumber"];
1051
+ /** @description FaxNumber
1052
+ * Collection of information that identifies a fax number, as defined by telecom services.
1053
+ * */
905
1054
  FaxNb?: components["schemas"]["PhoneNumber"];
1055
+ /** @description URLAddress
1056
+ * Address for the Universal Resource Locator (URL), for example an address used over the www (HTTP) service.
1057
+ * */
906
1058
  URLAdr?: components["schemas"]["Max2048Text"];
1059
+ /** @description EmailAddress
1060
+ * Address for electronic mail (e-mail).
1061
+ * */
907
1062
  EmailAdr?: components["schemas"]["Max256Text"];
1063
+ /** @description EmailPurpose
1064
+ * Purpose for which an email address may be used.
1065
+ * */
908
1066
  EmailPurp?: components["schemas"]["Max35Text"];
1067
+ /** @description JobTitle
1068
+ * Title of the function.
1069
+ * */
909
1070
  JobTitl?: components["schemas"]["Max35Text"];
1071
+ /** @description Responsibility
1072
+ * Role of a person in an organisation.
1073
+ * */
910
1074
  Rspnsblty?: components["schemas"]["Max35Text"];
1075
+ /** @description Department
1076
+ * Identification of a division of a large organisation or building.
1077
+ * */
911
1078
  Dept?: components["schemas"]["Max70Text"];
1079
+ /** @description OtherContact
1080
+ * Contact details in another form.
1081
+ * */
912
1082
  Othr?: components["schemas"]["OtherContact1"];
1083
+ /** @description PreferredContactMethod
1084
+ * Preferred method used to reach the contact.
1085
+ * */
913
1086
  PrefrdMtd?: components["schemas"]["PreferredContactMethod2Code"];
914
1087
  };
915
1088
  /**
@@ -926,21 +1099,59 @@ export interface components {
926
1099
  * }
927
1100
  */
928
1101
  Contact4: {
1102
+ /** @description NamePrefix
1103
+ * Name prefix to be used before the name of the person.
1104
+ * */
929
1105
  NmPrfx?: components["schemas"]["NamePrefix2Code"];
1106
+ /** @description Name
1107
+ * Name by which a party is known and which is usually used to identify that party.
1108
+ * */
930
1109
  Nm?: components["schemas"]["Max140Text"];
1110
+ /** @description PhoneNumber
1111
+ * Collection of information that identifies a phone number, as defined by telecom services.
1112
+ * */
931
1113
  PhneNb?: components["schemas"]["PhoneNumber"];
1114
+ /** @description MobilePhoneNumber
1115
+ * Collection of information that identifies a mobile phone number, as defined by telecom services.
1116
+ * */
932
1117
  MobNb?: components["schemas"]["PhoneNumber"];
1118
+ /** @description FaxNumber
1119
+ * Collection of information that identifies a fax number, as defined by telecom services.
1120
+ * */
933
1121
  FaxNb?: components["schemas"]["PhoneNumber"];
1122
+ /** @description EmailAddress
1123
+ * Address for electronic mail (e-mail).
1124
+ * */
934
1125
  EmailAdr?: components["schemas"]["Max2048Text"];
1126
+ /** @description EmailPurpose
1127
+ * Purpose for which an email address may be used.
1128
+ * */
935
1129
  EmailPurp?: components["schemas"]["Max35Text"];
1130
+ /** @description JobTitle
1131
+ * Title of the function.
1132
+ * */
936
1133
  JobTitl?: components["schemas"]["Max35Text"];
1134
+ /** @description Responsibility
1135
+ * Role of a person in an organisation.
1136
+ * */
937
1137
  Rspnsblty?: components["schemas"]["Max35Text"];
1138
+ /** @description Department
1139
+ * Identification of a division of a large organisation or building.
1140
+ * */
938
1141
  Dept?: components["schemas"]["Max70Text"];
1142
+ /** @description Other
1143
+ * : Contact details in another form.
1144
+ * */
939
1145
  Othr?: components["schemas"]["OtherContact1"];
1146
+ /** @description PreferredMethod
1147
+ * Preferred method used to reach the contact.
1148
+ * */
940
1149
  PrefrdMtd?: components["schemas"]["PreferredContactMethod1Code"];
941
1150
  };
942
1151
  /**
943
1152
  * CountryCode
1153
+ * @description Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).
1154
+ *
944
1155
  * @example US
945
1156
  */
946
1157
  CountryCode: string;
@@ -1052,23 +1263,78 @@ export interface components {
1052
1263
  * }
1053
1264
  */
1054
1265
  CreditTransferTransaction67: {
1266
+ /** @description PaymentIdentification
1267
+ * Set of elements used to reference a payment instruction.
1268
+ * */
1055
1269
  PmtId: components["schemas"]["PaymentIdentification13"];
1270
+ /** @description PaymentTypeInformation
1271
+ *
1272
+ * Set of elements used to further specify the type of transaction.
1273
+ * */
1056
1274
  PmtTpInf?: components["schemas"]["PaymentTypeInformation28"];
1275
+ /** @description InterbankSettlementAmount
1276
+ * Amount of money moved between the instructing agent and the instructed agent.
1277
+ * */
1057
1278
  IntrBkSttlmAmt: components["schemas"]["ActiveCurrencyAndAmount"];
1279
+ /** @description InstructedAmount
1280
+ * Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.
1281
+ * */
1058
1282
  InstdAmt?: components["schemas"]["ActiveOrHistoricCurrencyAndAmount"];
1283
+ /** @description ExchangeRate
1284
+ * Factor used to convert an amount from one currency into another. This reflects the price at which one currency was bought with another currency.
1285
+ * */
1059
1286
  XchgRate?: components["schemas"]["BaseOneRate"];
1287
+ /** @description ChargeBearer
1288
+ * Specifies which party/parties will bear the charges associated with the processing of the payment transaction.
1289
+ * */
1060
1290
  ChrgBr: components["schemas"]["ChargeBearerType1Code"];
1291
+ /** @description ChargesInformation
1292
+ * Provides information on the charges to be paid by the charge bearer(s) related to the payment transaction
1293
+ * */
1061
1294
  ChrgsInf?: components["schemas"]["Charges16"];
1295
+ /** @description Debtor
1296
+ * Party that owes an amount of money to the (ultimate) creditor.
1297
+ * */
1062
1298
  Dbtr: components["schemas"]["PartyIdentification272"];
1299
+ /** @description DebtorAccount
1300
+ * Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
1301
+ * */
1063
1302
  DbtrAcct?: components["schemas"]["CashAccount40"];
1303
+ /** @description DebtorAgent
1304
+ * Financial institution servicing an account for the debtor.
1305
+ * */
1064
1306
  DbtrAgt: components["schemas"]["BranchAndFinancialInstitutionIdentification8"];
1307
+ /** @description CreditorAgent
1308
+ * Financial institution servicing an account for the creditor.
1309
+ * */
1065
1310
  CdtrAgt: components["schemas"]["BranchAndFinancialInstitutionIdentification8"];
1311
+ /** @description Creditor
1312
+ * Party to which an amount of money is due.
1313
+ * */
1066
1314
  Cdtr: components["schemas"]["PartyIdentification272"];
1315
+ /** @description CreditorAccount
1316
+ * Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.
1317
+ * */
1067
1318
  CdtrAcct?: components["schemas"]["CashAccount40"];
1319
+ /** @description InstructionForCreditorAgent
1320
+ * Set of elements used to provide information on the remittance advice.
1321
+ * */
1068
1322
  InstrForCdtrAgt?: components["schemas"]["InstructionForCreditorAgent3"];
1323
+ /** @description InstructionForNextAgent
1324
+ * Set of elements used to provide information on the remittance advice.
1325
+ * */
1069
1326
  InstrForNxtAgt?: components["schemas"]["InstructionForNextAgent1"];
1327
+ /** @description Purpose
1328
+ * Underlying reason for the payment transaction.
1329
+ * */
1070
1330
  Purp?: components["schemas"]["Purpose2Choice"];
1331
+ /** @description RegulatoryReporting
1332
+ * Information needed due to regulatory and statutory requirements.
1333
+ * */
1071
1334
  RgltryRptg?: components["schemas"]["RegulatoryReporting3"];
1335
+ /** @description Tax
1336
+ * Provides details on the tax.
1337
+ * */
1072
1338
  Tax?: components["schemas"]["TaxData1"];
1073
1339
  VrfctnOfTerms?: components["schemas"]["CryptographicLockChoice"];
1074
1340
  };
@@ -1130,17 +1396,54 @@ export interface components {
1130
1396
  * }
1131
1397
  */
1132
1398
  CreditTransferTransaction68: {
1399
+ /** @description PaymentIdentification
1400
+ * Set of elements used to reference a payment instruction.
1401
+ * */
1133
1402
  PmtId: components["schemas"]["PaymentIdentification13"];
1403
+ /** @description PaymentTypeInformation
1404
+ *
1405
+ * Set of elements used to further specify the type of transaction.
1406
+ * */
1134
1407
  PmtTpInf?: components["schemas"]["PaymentTypeInformation28"];
1408
+ /** @description InterbankSettlementAmount
1409
+ * Amount of money moved between the instructing agent and the instructed agent.
1410
+ * */
1135
1411
  IntrBkSttlmAmt: components["schemas"]["ActiveCurrencyAndAmount"];
1412
+ /** @description Debtor
1413
+ * Party that owes an amount of money to the (ultimate) creditor.
1414
+ * */
1136
1415
  Dbtr: components["schemas"]["BranchAndFinancialInstitutionIdentification8"];
1416
+ /** @description DebtorAccount
1417
+ * Account used to process a payment.
1418
+ * */
1137
1419
  DbtrAcct?: components["schemas"]["CashAccount40"];
1420
+ /** @description DebtorAgent
1421
+ * Financial institution servicing an account for the debtor.
1422
+ * */
1138
1423
  DbtrAgt?: components["schemas"]["BranchAndFinancialInstitutionIdentification8"];
1424
+ /** @description CreditorAgent
1425
+ * Financial institution servicing an account for the creditor.
1426
+ * */
1139
1427
  CdtrAgt?: components["schemas"]["BranchAndFinancialInstitutionIdentification8"];
1428
+ /** @description Creditor
1429
+ * Party to which an amount of money is due.
1430
+ * */
1140
1431
  Cdtr: components["schemas"]["BranchAndFinancialInstitutionIdentification8"];
1432
+ /** @description CreditorAccount
1433
+ * Account to which a credit entry is made.
1434
+ * */
1141
1435
  CdtrAcct?: components["schemas"]["CashAccount40"];
1436
+ /** @description InstructionForCreditorAgent
1437
+ * Set of elements used to provide information on the remittance advice.
1438
+ * */
1142
1439
  InstrForCdtrAgt?: components["schemas"]["InstructionForCreditorAgent3"];
1440
+ /** @description Purpose
1441
+ * Underlying reason for the payment transaction.
1442
+ * */
1143
1443
  Purp?: components["schemas"]["Purpose2Choice"];
1444
+ /** @description VerificationOfTerms
1445
+ * Set of elements used to provide information on the underlying terms of the transaction.
1446
+ * */
1144
1447
  VrfctnOfTerms?: components["schemas"]["CryptographicLockChoice"];
1145
1448
  };
1146
1449
  /**
@@ -1167,9 +1470,21 @@ export interface components {
1167
1470
  * }
1168
1471
  */
1169
1472
  DateAndPlaceOfBirth1: {
1473
+ /** @description BirthDate
1474
+ * Date on which a person is born.
1475
+ * */
1170
1476
  BirthDt: components["schemas"]["ISODate"];
1477
+ /** @description ProvinceOfBirth
1478
+ * Province where a person was born.
1479
+ * */
1171
1480
  PrvcOfBirth?: components["schemas"]["Max35Text"];
1481
+ /** @description CityOfBirth
1482
+ * City where a person was born.
1483
+ * */
1172
1484
  CityOfBirth: components["schemas"]["Max35Text"];
1485
+ /** @description CountryOfBirth
1486
+ * Country where a person was born.
1487
+ * */
1173
1488
  CtryOfBirth: components["schemas"]["CountryCode"];
1174
1489
  };
1175
1490
  /**
@@ -1177,12 +1492,18 @@ export interface components {
1177
1492
  * @description Range of time defined by a start date and an end date.
1178
1493
  *
1179
1494
  * @example {
1180
- * "FrDt": "2020-01-01",
1181
- * "ToDt": "2020-12-31"
1495
+ * "FrDt": "2022-01-01T00:00:00.000Z",
1496
+ * "ToDt": "2022-12-31T23:59:59.999Z"
1182
1497
  * }
1183
1498
  */
1184
1499
  DatePeriod2: {
1500
+ /** @description FromDate
1501
+ * Start date of the range.
1502
+ * */
1185
1503
  FrDt: components["schemas"]["ISODate"];
1504
+ /** @description ToDate
1505
+ * End date of the range.
1506
+ * */
1186
1507
  ToDt: components["schemas"]["ISODate"];
1187
1508
  };
1188
1509
  /**
@@ -1231,89 +1552,93 @@ export interface components {
1231
1552
  * Execute_FIToFICustomerCreditTransferV13
1232
1553
  * @example {
1233
1554
  * "GrpHdr": {
1234
- * "MsgId": 123456789,
1555
+ * "MsgId": 12345,
1235
1556
  * "CreDtTm": "2020-01-01T00:00:00Z",
1557
+ * "PmtInstrXpryDtTm": "2020-01-01T00:00:00Z",
1236
1558
  * "NbOfTxs": 1,
1237
- * "CtrlSum": 100,
1238
- * "InitgPty": {
1239
- * "Nm": "Initiating Party Name",
1240
- * "Id": {
1241
- * "OrgId": {
1242
- * "Othr": [
1243
- * {
1244
- * "Id": 123456789,
1245
- * "SchmeNm": {
1246
- * "Cd": 91
1247
- * }
1248
- * }
1249
- * ]
1559
+ * "SttlmInf": {
1560
+ * "SttlmMtd": "INDA",
1561
+ * "SttlmAcct": {
1562
+ * "Id": {
1563
+ * "IBAN": 123
1250
1564
  * }
1565
+ * },
1566
+ * "SttlmAcctOwnr": {
1567
+ * "Nm": "John Doe"
1568
+ * },
1569
+ * "SttlmAcctSvcr": {
1570
+ * "BICFI": 123
1251
1571
  * }
1252
1572
  * },
1253
- * "FwdgAgt": {
1254
- * "FinInstnId": {
1255
- * "BICFI": "BBBBBBBB"
1573
+ * "CdtTrfTxInf": {
1574
+ * "PmtId": {
1575
+ * "InstrId": 123,
1576
+ * "EndToEndId": 123
1577
+ * },
1578
+ * "PmtTpInf": {
1579
+ * "InstrPrty": "NORM"
1580
+ * },
1581
+ * "InstdAmt": {
1582
+ * "Amt": 123,
1583
+ * "Ccy": "EUR"
1584
+ * },
1585
+ * "ChrgBr": "SLEV",
1586
+ * "CdtrAgt": {
1587
+ * "FinInstnId": {
1588
+ * "BICFI": 123
1589
+ * }
1590
+ * },
1591
+ * "Cdtr": {
1592
+ * "Nm": "John Doe"
1593
+ * },
1594
+ * "CdtrAcct": {
1595
+ * "Id": {
1596
+ * "IBAN": 123
1597
+ * }
1598
+ * },
1599
+ * "RmtInf": {
1600
+ * "Ustrd": "Test"
1256
1601
  * }
1257
1602
  * }
1258
1603
  * },
1259
1604
  * "CdtTrfTxInf": {
1260
1605
  * "PmtId": {
1261
- * "InstrId": 123456789,
1262
- * "EndToEndId": 123456789
1606
+ * "InstrId": 123,
1607
+ * "EndToEndId": 123
1263
1608
  * },
1264
1609
  * "PmtTpInf": {
1265
- * "InstrPrty": "NORM",
1266
- * "CtgyPurp": {
1267
- * "Cd": "SUPP"
1268
- * }
1610
+ * "InstrPrty": "NORM"
1269
1611
  * },
1270
- * "InstrForCdtrAgt": {
1271
- * "FinInstnId": {
1272
- * "BICFI": "AAAAAAAA"
1273
- * }
1612
+ * "InstdAmt": {
1613
+ * "Amt": 123,
1614
+ * "Ccy": "EUR"
1274
1615
  * },
1616
+ * "ChrgBr": "SLEV",
1275
1617
  * "CdtrAgt": {
1276
1618
  * "FinInstnId": {
1277
- * "BICFI": "AAAAAAAA"
1619
+ * "BICFI": 123
1278
1620
  * }
1279
1621
  * },
1280
1622
  * "Cdtr": {
1281
- * "Nm": "Creditor Name",
1282
- * "PstlAdr": {
1283
- * "AdrLine": [
1284
- * "Creditor Address Line 1",
1285
- * "Creditor Address Line 2",
1286
- * "Creditor Address Line 3",
1287
- * "Creditor Address Line 4",
1288
- * "Creditor Address Line 5"
1289
- * ]
1290
- * },
1291
- * "Id": {
1292
- * "OrgId": {
1293
- * "Othr": [
1294
- * {
1295
- * "Id": 123456789,
1296
- * "SchmeNm": {
1297
- * "Cd": 91
1298
- * }
1299
- * }
1300
- * ]
1301
- * }
1302
- * }
1623
+ * "Nm": "John Doe"
1303
1624
  * },
1304
1625
  * "CdtrAcct": {
1305
1626
  * "Id": {
1306
- * "IBAN": "DE87123456781234567890"
1627
+ * "IBAN": 123
1307
1628
  * }
1308
1629
  * },
1309
1630
  * "RmtInf": {
1310
- * "Ustrd": "Remittance Information"
1631
+ * "Ustrd": "Test"
1311
1632
  * }
1312
1633
  * }
1313
1634
  * }
1314
1635
  */
1315
1636
  Execute_FIToFICustomerCreditTransferV13: {
1637
+ /** @description GroupHeader.
1638
+ * */
1316
1639
  GrpHdr: components["schemas"]["GroupHeader129"];
1640
+ /** @description CreditTransferTransactionInformation.
1641
+ * */
1317
1642
  CdtTrfTxInf: components["schemas"]["CreditTransferTransaction67"];
1318
1643
  };
1319
1644
  /**
@@ -1436,189 +1761,250 @@ export interface components {
1436
1761
  * }
1437
1762
  */
1438
1763
  FinancialIdentificationSchemeName1Choice: {
1764
+ /** @description Code
1765
+ * Name of the identification scheme, in a coded form as published in an external list.
1766
+ * */
1439
1767
  Cd?: components["schemas"]["ExternalFinancialInstitutionIdentification1Code"];
1768
+ /** @description Proprietary
1769
+ * Name of the identification scheme, in a free text form.
1770
+ * */
1440
1771
  Prtry?: components["schemas"]["Max35Text"];
1441
1772
  } & (unknown | unknown);
1442
1773
  /**
1443
1774
  * FinancialInstitutionIdentification18
1444
1775
  * @example {
1445
- * "BICFI": "BUKBGB22",
1446
- * "Nm": "Barclays Bank Plc",
1776
+ * "BICFI": "J5BMVH7D",
1777
+ * "ClrSysMmbId": {
1778
+ * "ClrSysId": 1234,
1779
+ * "MmbId": 123
1780
+ * },
1781
+ * "LEI": 123,
1782
+ * "Nm": "Name",
1447
1783
  * "PstlAdr": {
1448
- * "Ctry": "GB",
1449
- * "AdrLine": [
1450
- * "1 Churchill Place",
1451
- * "London",
1452
- * "UK"
1453
- * ]
1784
+ * "AdrTp": "ADDR",
1785
+ * "Dept": "Department",
1786
+ * "SubDept": "Sub department",
1787
+ * "StrtNm": "Street name",
1788
+ * "BldgNb": "Building number",
1789
+ * "PstCd": "Post code",
1790
+ * "TwnNm": "Town name",
1791
+ * "CtrySubDvsn": "Country subdivision",
1792
+ * "Ctry": "Country",
1793
+ * "AdrLine": "Address line"
1794
+ * },
1795
+ * "Othr": {
1796
+ * "Id": 123,
1797
+ * "SchmeNm": {
1798
+ * "Cd": 123,
1799
+ * "Prtry": 123
1800
+ * },
1801
+ * "Issr": 123
1454
1802
  * }
1455
1803
  * }
1456
1804
  */
1457
1805
  FinancialInstitutionIdentification18: {
1806
+ /** @description BICFI
1807
+ * Code allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 "Banking - Banking telecommunication messages - Business identifier code (BIC)"
1808
+ * */
1458
1809
  BICFI?: components["schemas"]["BICFIDec2014Identifier"];
1810
+ /** @description ClearingSystemMemberIdentification
1811
+ * Information used to identify a member within a clearing system
1812
+ * */
1459
1813
  ClrSysMmbId?: components["schemas"]["ClearingSystemMemberIdentification2"];
1814
+ /** @description LEI
1815
+ * Legal entity identifier of the financial institution.
1816
+ * */
1460
1817
  LEI?: components["schemas"]["LEIIdentifier"];
1818
+ /** @description Name
1819
+ * Name by which an agent is known and which is usually used to identify that agent
1820
+ * */
1461
1821
  Nm?: components["schemas"]["Max140Text"];
1822
+ /** @description PostalAddress
1823
+ * Information that locates and identifies a specific address, as defined by postal services.
1824
+ * */
1462
1825
  PstlAdr?: components["schemas"]["PostalAddress24"];
1826
+ /** @description Other
1827
+ * Unique identification of an agent, as assigned by an institution, using an identification scheme.
1828
+ * */
1463
1829
  Othr?: components["schemas"]["GenericFinancialIdentification1"];
1464
1830
  };
1465
1831
  /**
1466
1832
  * FinancialInstitutionIdentification23
1467
1833
  * @example {
1468
- * "BICFI": "BUKBGB22",
1469
- * "Nm": "Barclays Bank Plc",
1834
+ * "BICFI": "J5BMVH7D",
1835
+ * "ClrSysMmbId": {
1836
+ * "ClrSysId": {
1837
+ * "Cd": "CHQB"
1838
+ * },
1839
+ * "MmbId": 123456789
1840
+ * },
1841
+ * "LEI": 123,
1842
+ * "Nm": "Name",
1470
1843
  * "PstlAdr": {
1471
- * "Ctry": "GB",
1472
- * "AdrLine": [
1473
- * "1 Churchill Place",
1474
- * "London",
1475
- * "UK"
1476
- * ]
1844
+ * "AdrTp": "ADDR",
1845
+ * "Dept": "Department",
1846
+ * "SubDept": "Sub department",
1847
+ * "StrtNm": "Street name",
1848
+ * "BldgNb": "Building number",
1849
+ * "PstCd": "Post code",
1850
+ * "TwnNm": "Town name",
1851
+ * "CtrySubDvsn": "Country subdivision",
1852
+ * "Ctry": "Country",
1853
+ * "AdrLine": "Address line"
1854
+ * },
1855
+ * "Othr": {
1856
+ * "Id": 123,
1857
+ * "SchmeNm": {
1858
+ * "Cd": "CHQB"
1859
+ * },
1860
+ * "Issr": 123
1477
1861
  * }
1478
1862
  * }
1479
1863
  */
1480
1864
  FinancialInstitutionIdentification23: {
1865
+ /** @description BICFI
1866
+ * Code allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 "Banking - Banking telecommunication messages - Business identifier code (BIC)"
1867
+ * */
1481
1868
  BICFI?: components["schemas"]["BICFIDec2014Identifier"];
1869
+ /** @description ClearingSystemMemberIdentification
1870
+ * Information used to identify a member within a clearing system
1871
+ * */
1482
1872
  ClrSysMmbId?: components["schemas"]["ClearingSystemMemberIdentification2"];
1873
+ /** @description LEI
1874
+ * Legal entity identifier of the financial institution.
1875
+ * */
1483
1876
  LEI?: components["schemas"]["LEIIdentifier"];
1877
+ /** @description Name
1878
+ * Name by which an agent is known and which is usually used to identify that agent
1879
+ * */
1484
1880
  Nm?: components["schemas"]["Max140Text"];
1881
+ /** @description PostalAddress
1882
+ * Information that locates and identifies a specific address, as defined by postal services.
1883
+ * */
1485
1884
  PstlAdr?: components["schemas"]["PostalAddress27"];
1885
+ /** @description Other
1886
+ * Unique identification of an agent, as assigned by an institution, using an identification scheme.
1887
+ * */
1486
1888
  Othr?: components["schemas"]["GenericFinancialIdentification1"];
1487
1889
  };
1488
1890
  /**
1489
1891
  * FxRequest_FICreditTransferProposal
1490
1892
  * @example {
1491
1893
  * "GrpHdr": {
1492
- * "MsgId": 123456789,
1894
+ * "MsgId": 12345,
1493
1895
  * "CreDtTm": "2020-01-01T00:00:00Z",
1494
1896
  * "NbOfTxs": 1,
1495
- * "CtrlSum": 100,
1496
- * "InitgPty": {
1497
- * "Nm": "Initiating Party Name",
1498
- * "Id": {
1499
- * "OrgId": {
1500
- * "Othr": [
1501
- * {
1502
- * "Id": 123456789,
1503
- * "SchmeNm": {
1504
- * "Cd": "BIC"
1505
- * }
1506
- * }
1507
- * ]
1508
- * }
1509
- * }
1510
- * },
1511
- * "FwdgAgt": {
1512
- * "FinInstnId": {
1513
- * "BICFI": "BICFID0"
1514
- * }
1897
+ * "TtlIntrBkSttlmAmt": {
1898
+ * "Ccy": "EUR",
1899
+ * "Value": 100
1515
1900
  * },
1516
- * "Dbtr": {
1517
- * "Nm": "Debtor Name",
1518
- * "PstlAdr": {
1519
- * "AdrLine": [
1520
- * "Debtor Address Line 1",
1521
- * "Debtor Address Line 2"
1522
- * ]
1901
+ * "SttlmInf": {
1902
+ * "SttlmMtd": "INDA",
1903
+ * "SttlmAcct": {
1904
+ * "Id": {
1905
+ * "IBAN": "BE71096123456769"
1906
+ * },
1907
+ * "Ccy": "EUR"
1523
1908
  * },
1524
- * "Id": {
1525
- * "OrgId": {
1526
- * "Othr": [
1527
- * {
1528
- * "Id": 123456789,
1529
- * "SchmeNm": {
1530
- * "Cd": "BIC"
1531
- * }
1532
- * }
1533
- * ]
1909
+ * "SttlmAcctOwnr": {
1910
+ * "Nm": "Name"
1911
+ * },
1912
+ * "SttlmAcctSvcr": {
1913
+ * "Nm": "Name"
1914
+ * },
1915
+ * "SttlmAgt": {
1916
+ * "FinInstnId": {
1917
+ * "BICFI": "BIC"
1534
1918
  * }
1535
1919
  * }
1536
1920
  * },
1537
- * "DbtrAcct": {
1538
- * "Id": {
1539
- * "IBAN": "BE71096123456769"
1540
- * }
1541
- * },
1542
- * "DbtrAgt": {
1543
- * "FinInstnId": {
1544
- * "BICFI": "BICFID0"
1545
- * }
1921
+ * "PmtTpInf": {
1922
+ * "InstrPrty": "NORM",
1923
+ * "CtgyPurp": "CASH"
1546
1924
  * },
1547
- * "Cdtr": {
1548
- * "Nm": "Creditor Name",
1549
- * "PstlAdr": {
1550
- * "AdrLine": [
1551
- * "Creditor Address Line 1",
1552
- * "Creditor Address Line 2"
1553
- * ]
1925
+ * "CdtTrfTxInf": {
1926
+ * "PmtId": {
1927
+ * "InstrId": 12345,
1928
+ * "EndToEndId": 12345
1554
1929
  * },
1555
- * "Id": {
1556
- * "OrgId": {
1557
- * "Othr": [
1558
- * {
1559
- * "Id": 123456789,
1560
- * "SchmeNm": {
1561
- * "Cd": "BIC"
1562
- * }
1563
- * }
1564
- * ]
1930
+ * "Amt": {
1931
+ * "InstdAmt": {
1932
+ * "Ccy": "EUR",
1933
+ * "Value": 100
1565
1934
  * }
1566
- * }
1567
- * },
1568
- * "CdtrAcct": {
1569
- * "Id": {
1570
- * "IBAN": "BE71096123456769"
1571
- * }
1572
- * },
1573
- * "CdtrAgt": {
1574
- * "FinInstnId": {
1575
- * "BICFI": "BICFID0"
1576
- * }
1577
- * },
1578
- * "CdtTrfTxInf": [
1579
- * {
1580
- * "PmtId": {
1581
- * "InstrId": 123456789,
1582
- * "EndToEndId": 123456789
1935
+ * },
1936
+ * "Cdtr": {
1937
+ * "Nm": "Name"
1938
+ * },
1939
+ * "CdtrAcct": {
1940
+ * "Id": {
1941
+ * "IBAN": "BE71096123456769"
1583
1942
  * },
1584
- * "Amt": {
1585
- * "InstdAmt": {
1586
- * "Ccy": "EUR",
1587
- * "Amt": 100
1588
- * }
1943
+ * "Ccy": "EUR"
1944
+ * },
1945
+ * "CdtrAgt": {
1946
+ * "FinInstnId": {
1947
+ * "BICFI": "BIC"
1948
+ * }
1949
+ * },
1950
+ * "Dbtr": {
1951
+ * "Nm": "Name"
1952
+ * },
1953
+ * "DbtrAcct": {
1954
+ * "Id": {
1955
+ * "IBAN": "BE71096123456769"
1956
+ * },
1957
+ * "Ccy": "EUR"
1958
+ * },
1959
+ * "DbtrAgt": {
1960
+ * "FinInstnId": {
1961
+ * "BICFI": "BIC"
1962
+ * }
1963
+ * },
1964
+ * "IntrBkSttlmAmt": {
1965
+ * "Ccy": "EUR",
1966
+ * "Value": 100
1967
+ * },
1968
+ * "PmtTpInf": {
1969
+ * "InstrPrty": "NORM",
1970
+ * "ClrChanl": "RTGS",
1971
+ * "SvcLvl": {
1972
+ * "Cd": "SEPA"
1973
+ * },
1974
+ * "LclInstrm": {
1975
+ * "Cd": "CORE"
1976
+ * },
1977
+ * "CtgyPurp": {
1978
+ * "Cd": "CASH"
1979
+ * }
1980
+ * },
1981
+ * "RgltryRptg": {
1982
+ * "Dbtr": {
1983
+ * "Nm": "Name"
1589
1984
  * },
1590
- * "CdtrAgt": {
1985
+ * "DbtrAcct": {
1986
+ * "Id": {
1987
+ * "IBAN": "BE71096123456769"
1988
+ * },
1989
+ * "Ccy": "EUR"
1990
+ * },
1991
+ * "DbtrAgt": {
1591
1992
  * "FinInstnId": {
1592
- * "BICFI": "BICFID0"
1993
+ * "BICFI": "BIC"
1593
1994
  * }
1594
1995
  * },
1595
1996
  * "Cdtr": {
1596
- * "Nm": "Creditor Name",
1597
- * "PstlAdr": {
1598
- * "AdrLine": [
1599
- * "Creditor Address Line 1",
1600
- * "Creditor Address Line 2"
1601
- * ]
1602
- * },
1603
- * "Id": {
1604
- * "OrgId": {
1605
- * "Othr": [
1606
- * {
1607
- * "Id": 123456789,
1608
- * "SchmeNm": {
1609
- * "Cd": "BIC"
1610
- * }
1611
- * }
1612
- * ]
1613
- * }
1614
- * }
1997
+ * "Nm": "Name"
1615
1998
  * }
1616
1999
  * }
1617
- * ]
2000
+ * }
1618
2001
  * }
1619
2002
  * }
1620
2003
  */
1621
2004
  FxRequest_FICreditTransferProposal: {
2005
+ /** @description GroupHeader
2006
+ * Set of characteristics shared by all individual transactions included in the message.
2007
+ * */
1622
2008
  GrpHdr: components["schemas"]["GroupHeader113"];
1623
2009
  };
1624
2010
  /**
@@ -1728,7 +2114,13 @@ export interface components {
1728
2114
  * }
1729
2115
  */
1730
2116
  FxResponse_FICreditTransferConfirmation: {
2117
+ /** @description GroupHeader
2118
+ * Set of characteristics shared by all individual transactions included in the message.
2119
+ * */
1731
2120
  GrpHdr: components["schemas"]["GroupHeader113"];
2121
+ /** @description CreditTransferTransactionInformation
2122
+ * Set of elements providing information specific to the individual credit transfer(s).
2123
+ * */
1732
2124
  CdtTrfTxInf: components["schemas"]["CreditTransferTransaction68"];
1733
2125
  };
1734
2126
  /**
@@ -1807,7 +2199,13 @@ export interface components {
1807
2199
  * }
1808
2200
  */
1809
2201
  Fxecute_FinancialInstitutionCreditTransferV12: {
2202
+ /** @description GroupHeader.
2203
+ * Set of characteristics shared by all individual transactions included in the message.
2204
+ * */
1810
2205
  GrpHdr: components["schemas"]["GroupHeader129"];
2206
+ /** @description CreditTransferTransactionInformation.
2207
+ * Set of elements providing information specific to the individual credit transfer(s).
2208
+ * */
1811
2209
  CdtTrfTxInf: components["schemas"]["CreditTransferTransaction68"];
1812
2210
  };
1813
2211
  /**
@@ -1821,8 +2219,17 @@ export interface components {
1821
2219
  * }
1822
2220
  */
1823
2221
  GenericAccountIdentification1: {
2222
+ /** @description Identification
2223
+ * Identification assigned by an institution.
2224
+ * */
1824
2225
  Id: components["schemas"]["Max34Text"];
2226
+ /** @description SchemeName
2227
+ * Name of the identification scheme.
2228
+ * */
1825
2229
  SchmeNm?: components["schemas"]["AccountSchemeName1Choice"];
2230
+ /** @description Issuer
2231
+ * Entity that assigns the identification.
2232
+ * */
1826
2233
  Issr?: components["schemas"]["Max35Text"];
1827
2234
  };
1828
2235
  /**
@@ -1836,8 +2243,17 @@ export interface components {
1836
2243
  * }
1837
2244
  */
1838
2245
  GenericFinancialIdentification1: {
2246
+ /** @description Identification
2247
+ * Unique and unambiguous identification of a person.
2248
+ * */
1839
2249
  Id: components["schemas"]["Max35Text"];
2250
+ /** @description SchemeName
2251
+ * Name of the identification scheme.
2252
+ * */
1840
2253
  SchmeNm?: components["schemas"]["FinancialIdentificationSchemeName1Choice"];
2254
+ /** @description Issuer
2255
+ * Entity that assigns the identification.
2256
+ * */
1841
2257
  Issr?: components["schemas"]["Max35Text"];
1842
2258
  };
1843
2259
  /**
@@ -1848,7 +2264,13 @@ export interface components {
1848
2264
  * }
1849
2265
  */
1850
2266
  GenericIdentification3: {
2267
+ /** @description Identification
2268
+ * Name or number assigned by an entity to enable recognition of that entity, for example, account identifier.
2269
+ * */
1851
2270
  Id: components["schemas"]["Max35Text"];
2271
+ /** @description Issuer
2272
+ * Entity that assigns the identification.
2273
+ * */
1852
2274
  Issr?: components["schemas"]["Max35Text"];
1853
2275
  };
1854
2276
  /**
@@ -1860,8 +2282,17 @@ export interface components {
1860
2282
  * }
1861
2283
  */
1862
2284
  GenericIdentification30: {
2285
+ /** @description Identification
2286
+ * Proprietary information, often a code, issued by the data source scheme issuer
2287
+ * */
1863
2288
  Id: components["schemas"]["Exact4AlphaNumericText"];
2289
+ /** @description Issuer
2290
+ * Entity that assigns the identification.
2291
+ * */
1864
2292
  Issr: components["schemas"]["Max35Text"];
2293
+ /** @description SchemeName
2294
+ * Short textual description of the scheme.
2295
+ * */
1865
2296
  SchmeNm?: components["schemas"]["Max35Text"];
1866
2297
  };
1867
2298
  /**
@@ -1875,8 +2306,17 @@ export interface components {
1875
2306
  * }
1876
2307
  */
1877
2308
  GenericOrganisationIdentification1: {
2309
+ /** @description Identification
2310
+ * Identification assigned by an institution.
2311
+ * */
1878
2312
  Id: components["schemas"]["Max35Text"];
2313
+ /** @description SchemeName
2314
+ * Name of the identification scheme.
2315
+ * */
1879
2316
  SchmeNm?: components["schemas"]["OrganisationIdentificationSchemeName1Choice"];
2317
+ /** @description Issuer
2318
+ * Entity that assigns the identification.
2319
+ * */
1880
2320
  Issr?: components["schemas"]["Max35Text"];
1881
2321
  };
1882
2322
  /**
@@ -1890,8 +2330,16 @@ export interface components {
1890
2330
  * }
1891
2331
  */
1892
2332
  GenericOrganisationIdentification3: {
2333
+ /** @description Identification
2334
+ * Identification assigned by an institution.
2335
+ * */
1893
2336
  Id: components["schemas"]["Max256Text"];
2337
+ /** @description SchemeName
2338
+ * Name of the identification scheme. */
1894
2339
  SchmeNm?: components["schemas"]["OrganisationIdentificationSchemeName1Choice"];
2340
+ /** @description Issuer
2341
+ * Entity that assigns the identification.
2342
+ * */
1895
2343
  Issr?: components["schemas"]["Max35Text"];
1896
2344
  };
1897
2345
  /**
@@ -1905,8 +2353,17 @@ export interface components {
1905
2353
  * }
1906
2354
  */
1907
2355
  GenericPersonIdentification1: {
2356
+ /** @description Identification
2357
+ * Unique and unambiguous identification of a person.
2358
+ * */
1908
2359
  Id: components["schemas"]["Max35Text"];
2360
+ /** @description SchemeName
2361
+ * Name of the identification scheme.
2362
+ * */
1909
2363
  SchmeNm?: components["schemas"]["PersonIdentificationSchemeName1Choice"];
2364
+ /** @description Issuer
2365
+ * Entity that assigns the identification.
2366
+ * */
1910
2367
  Issr?: components["schemas"]["Max35Text"];
1911
2368
  };
1912
2369
  /**
@@ -1920,8 +2377,17 @@ export interface components {
1920
2377
  * }
1921
2378
  */
1922
2379
  GenericPersonIdentification2: {
2380
+ /** @description Identification
2381
+ * Unique and unambiguous identification of a person.
2382
+ * */
1923
2383
  Id: components["schemas"]["Max256Text"];
2384
+ /** @description SchemeName
2385
+ * Name of the identification scheme.
2386
+ * */
1924
2387
  SchmeNm?: components["schemas"]["PersonIdentificationSchemeName1Choice"];
2388
+ /** @description Issuer
2389
+ * Entity that assigns the identification.
2390
+ * */
1925
2391
  Issr?: components["schemas"]["Max35Text"];
1926
2392
  };
1927
2393
  /**
@@ -1993,81 +2459,104 @@ export interface components {
1993
2459
  * }
1994
2460
  */
1995
2461
  GetPartiesError_IdentificationVerificationReportV03: {
2462
+ /** @description Assignment
2463
+ * Information related to the identification assignment.
2464
+ * */
1996
2465
  Assgnmt: components["schemas"]["IdentificationAssignment3"];
2466
+ /** @description Report
2467
+ * Information concerning the verification of the identification data for which verification was requested.
2468
+ * */
1997
2469
  Rpt: components["schemas"]["VerificationReport4"];
2470
+ /** @description SupplementaryData
2471
+ * Additional information that cannot be captured in the structured elements and/or any other specific block.
2472
+ * */
1998
2473
  SplmtryData?: components["schemas"]["SupplementaryData1"];
1999
2474
  };
2000
2475
  /**
2001
2476
  * GetParties_IdentificationVerificationReportV03
2002
2477
  * @example {
2003
2478
  * "Assgnmt": {
2004
- * "Id": 123,
2005
- * "CreDtTm": "2013-03-07T16:30:00",
2479
+ * "MsgId": 123,
2480
+ * "CreDtTm": "2020-01-01T00:00:00Z",
2006
2481
  * "Assgnr": {
2007
- * "Id": {
2008
- * "Id": 123,
2009
- * "SchmeNm": {
2010
- * "Cd": "IBAN"
2011
- * },
2012
- * "Issr": "BIC"
2482
+ * "OrgId": {
2483
+ * "Othr": {
2484
+ * "Id": 123,
2485
+ * "SchmeNm": {
2486
+ * "Cd": "BIC"
2487
+ * },
2488
+ * "Issr": "BIC"
2489
+ * }
2013
2490
  * }
2014
2491
  * },
2015
2492
  * "Assgne": {
2016
- * "Id": {
2017
- * "Id": 123,
2018
- * "SchmeNm": {
2019
- * "Cd": "IBAN"
2020
- * },
2021
- * "Issr": "BIC"
2493
+ * "OrgId": {
2494
+ * "Othr": {
2495
+ * "Id": "DFSPID"
2496
+ * }
2022
2497
  * }
2023
2498
  * }
2024
2499
  * },
2025
2500
  * "Rpt": {
2026
- * "Id": 123,
2027
- * "CreDtTm": "2013-03-07T16:30:00",
2028
- * "RptgPty": {
2029
- * "Id": {
2030
- * "Id": 123,
2031
- * "SchmeNm": {
2032
- * "Cd": "IBAN"
2501
+ * "OrgnlId": 12345678,
2502
+ * "Vrfctn": true,
2503
+ * "UpdtdPtyAndAcctId": {
2504
+ * "Pty": {
2505
+ * "Nm": "John Doe",
2506
+ * "PstlAdr": {
2507
+ * "AdrTp": "ADDR",
2508
+ * "Dept": "Dept",
2509
+ * "SubDept": "SubDept",
2510
+ * "StrtNm": "StrtNm",
2511
+ * "BldgNb": "BldgNb",
2512
+ * "BldgNm": "BldgNm",
2513
+ * "Flr": "Flr",
2514
+ * "PstBx": "PstBx",
2515
+ * "Room": "Room",
2516
+ * "PstCd": "PstCd",
2517
+ * "TwnNm": "TwnNm",
2518
+ * "TwnLctnNm": "TwnLctnNm",
2519
+ * "DstrctNm": "DstrctNm",
2520
+ * "CtrySubDvsn": "CtrySubDvsn",
2521
+ * "Ctry": "Ctry",
2522
+ * "AdrLine": "AdrLine"
2033
2523
  * },
2034
- * "Issr": "BIC"
2035
- * }
2036
- * },
2037
- * "RptdPty": {
2038
- * "Id": {
2039
- * "Id": 123,
2040
- * "SchmeNm": {
2041
- * "Cd": "IBAN"
2524
+ * "Id": {
2525
+ * "OrgId": {
2526
+ * "Othr": {
2527
+ * "Id": 18761231234
2528
+ * },
2529
+ * "SchmeNm": {
2530
+ * "Prtry": "MSISDN"
2531
+ * }
2532
+ * }
2042
2533
  * },
2043
- * "Issr": "BIC"
2044
- * }
2045
- * },
2046
- * "RptdDoc": {
2047
- * "Nb": 123,
2048
- * "RltdDt": "2013-03-07",
2049
- * "RltdDtTp": {
2050
- * "Cd": 123
2534
+ * "CtryOfRes": "BE",
2535
+ * "CtctDtls": {
2536
+ * "NmPrfx": "Mr",
2537
+ * "Nm": "John Doe",
2538
+ * "PhneNb": "+123-123-321",
2539
+ * "MobNb": "+123-123-321",
2540
+ * "FaxNb": "+123-123-321",
2541
+ * "EmailAdr": "example@example.com"
2542
+ * }
2051
2543
  * }
2052
- * },
2053
- * "Rsn": {
2054
- * "Cd": 123,
2055
- * "Prtry": 123
2056
- * }
2057
- * },
2058
- * "SplmtryData": {
2059
- * "PlcAndNm": 123,
2060
- * "Envlp": 123,
2061
- * "RltdDt": "2013-03-07",
2062
- * "RltdDtTp": {
2063
- * "Cd": 123
2064
2544
  * }
2065
2545
  * }
2066
2546
  * }
2067
2547
  */
2068
2548
  GetParties_IdentificationVerificationReportV03: {
2549
+ /** @description Assignment
2550
+ * Identifies the identification assignment.
2551
+ * */
2069
2552
  Assgnmt: components["schemas"]["IdentificationAssignment3"];
2553
+ /** @description Report
2554
+ * Information concerning the verification of the identification data for which verification was requested.
2555
+ * */
2070
2556
  Rpt: components["schemas"]["VerificationReport4"];
2557
+ /** @description SupplementaryData
2558
+ * Additional information that cannot be captured in the structured elements and/or any other specific block.
2559
+ * */
2071
2560
  SplmtryData?: components["schemas"]["SupplementaryData1"];
2072
2561
  };
2073
2562
  /**
@@ -2182,8 +2671,19 @@ export interface components {
2182
2671
  * }
2183
2672
  */
2184
2673
  GroupHeader120: {
2674
+ /** @description MessageIdentification
2675
+ * Definition: Point to point reference, as assigned by the instructing party, and sent to the next party in the chain to unambiguously identify the message.
2676
+ * Usage: The instructing party has to make sure that MessageIdentification is unique per instructed party for a pre-agreed period.
2677
+ * */
2185
2678
  MsgId: components["schemas"]["Max35Text"];
2679
+ /** @description CreationDateTime
2680
+ * Date and time at which the message was created.
2681
+ * */
2186
2682
  CreDtTm: components["schemas"]["ISODateTime"];
2683
+ /** @description TransactionInformationAndStatus
2684
+ * Definition: Agent that instructs the next party in the chain to carry out the (set of) instruction(s).
2685
+ * Usage: The instructing agent is the party sending the status message and not the party that sent the original instruction that is being reported on.
2686
+ * */
2187
2687
  TxInfAndSts?: components["schemas"]["PaymentTransaction163"];
2188
2688
  };
2189
2689
  /**
@@ -2326,8 +2826,17 @@ export interface components {
2326
2826
  */
2327
2827
  IdentificationAssignment3: {
2328
2828
  MsgId: components["schemas"]["Max35Text"];
2829
+ /** @description CreationDateTime
2830
+ * Date and time at which the identification assignment was created.
2831
+ * */
2329
2832
  CreDtTm: components["schemas"]["ISODateTime"];
2833
+ /** @description Assignor
2834
+ * Party that assigns the identification assignment to another party. This is also the sender of the message.
2835
+ * */
2330
2836
  Assgnr: components["schemas"]["Party40Choice"];
2837
+ /** @description Assignee
2838
+ * Party that the identification assignment is assigned to. This is also the receiver of the message.
2839
+ * */
2331
2840
  Assgne: components["schemas"]["Party40Choice"];
2332
2841
  };
2333
2842
  /**
@@ -2356,12 +2865,26 @@ export interface components {
2356
2865
  * }
2357
2866
  */
2358
2867
  IdentificationInformation4: {
2868
+ /** @description Party
2869
+ * Account owner that owes an amount of money or to whom an amount of money is due.
2870
+ * */
2359
2871
  Pty?: components["schemas"]["PartyIdentification135"];
2872
+ /** @description Account
2873
+ * Unambiguous identification of the account of a party.
2874
+ * */
2360
2875
  Acct?: components["schemas"]["CashAccount40"];
2876
+ /** @description Agent
2877
+ * Financial institution servicing an account for a party.
2878
+ * */
2361
2879
  Agt?: components["schemas"]["BranchAndFinancialInstitutionIdentification6"];
2362
2880
  };
2363
2881
  /**
2364
2882
  * IdentificationVerificationIndicator
2883
+ * @description Definition: Identifies whether the party and/or account information received is correct.
2884
+ *
2885
+ * • Meaning When True: Indicates that the identification information received is correct.
2886
+ * • Meaning When False: Indicates that the identification information received is incorrect
2887
+ *
2365
2888
  * @example true
2366
2889
  */
2367
2890
  IdentificationVerificationIndicator: boolean;
@@ -2385,7 +2908,13 @@ export interface components {
2385
2908
  * }
2386
2909
  */
2387
2910
  InstructionForCreditorAgent3: {
2911
+ /** @description Code
2912
+ * Coded information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor's agent.
2913
+ * */
2388
2914
  Cd?: components["schemas"]["ExternalCreditorAgentInstruction1Code"];
2915
+ /** @description InstructionInformation
2916
+ * Further information complementing the coded instruction or instruction to the creditor's agent that is bilaterally agreed or specific to a user community.
2917
+ * */
2389
2918
  InstrInf?: components["schemas"]["Max140Text"];
2390
2919
  };
2391
2920
  /**
@@ -2398,7 +2927,13 @@ export interface components {
2398
2927
  * }
2399
2928
  */
2400
2929
  InstructionForNextAgent1: {
2930
+ /** @description Code
2931
+ * Coded information related to the processing of the payment instruction, provided by the initiating party, and intended for the next agent in the payment chain.
2932
+ * */
2401
2933
  Cd?: components["schemas"]["Instruction4Code"];
2934
+ /** @description InstructionInformation
2935
+ * Further information complementing the coded instruction or instruction to the next agent that is bilaterally agreed or specific to a user community.
2936
+ * */
2402
2937
  InstrInf?: components["schemas"]["Max140Text"];
2403
2938
  };
2404
2939
  /**
@@ -2415,7 +2950,13 @@ export interface components {
2415
2950
  * }
2416
2951
  */
2417
2952
  LocalInstrument2Choice: {
2953
+ /** @description Code
2954
+ * Specifies the local instrument, as published in an external local instrument code list.
2955
+ * */
2418
2956
  Cd?: components["schemas"]["ExternalLocalInstrument1Code"];
2957
+ /** @description Proprietary
2958
+ * Specifies the local instrument, as a proprietary code
2959
+ * */
2419
2960
  Prtry?: components["schemas"]["Max35Text"];
2420
2961
  } & (unknown | unknown);
2421
2962
  /**
@@ -2538,8 +3079,17 @@ export interface components {
2538
3079
  * }
2539
3080
  */
2540
3081
  OrganisationIdentification29: {
3082
+ /** @description AnyBIC
3083
+ * Business identification code of the organisation.
3084
+ * */
2541
3085
  AnyBIC?: components["schemas"]["AnyBICDec2014Identifier"];
3086
+ /** @description LEI
3087
+ * Legal entity identification as an alternate identification for a party.
3088
+ * */
2542
3089
  LEI?: components["schemas"]["LEIIdentifier"];
3090
+ /** @description Other
3091
+ * Unique identification of an organisation, as assigned by an institution, using an identification scheme.
3092
+ * */
2543
3093
  Othr?: components["schemas"]["GenericOrganisationIdentification1"];
2544
3094
  };
2545
3095
  /**
@@ -2559,8 +3109,17 @@ export interface components {
2559
3109
  * }
2560
3110
  */
2561
3111
  OrganisationIdentification39: {
3112
+ /** @description AnyBIC
3113
+ * Business identification code of the organisation.
3114
+ * */
2562
3115
  AnyBIC?: components["schemas"]["AnyBICDec2014Identifier"];
3116
+ /** @description LEI
3117
+ * Legal entity identification as an alternate identification for a party.
3118
+ * */
2563
3119
  LEI?: components["schemas"]["LEIIdentifier"];
3120
+ /** @description Other
3121
+ * Unique identification of an organisation, as assigned by an institution, using an identification scheme.
3122
+ * */
2564
3123
  Othr?: components["schemas"]["GenericOrganisationIdentification3"];
2565
3124
  };
2566
3125
  /**
@@ -2572,7 +3131,13 @@ export interface components {
2572
3131
  * }
2573
3132
  */
2574
3133
  OrganisationIdentificationSchemeName1Choice: {
3134
+ /** @description Code
3135
+ * Name of the identification scheme, in a coded form as published in an external list.
3136
+ * */
2575
3137
  Cd?: components["schemas"]["ExternalOrganisationIdentification1Code"];
3138
+ /** @description Proprietary
3139
+ * Name of the identification scheme, in a free text form.
3140
+ * */
2576
3141
  Prtry?: components["schemas"]["Max35Text"];
2577
3142
  } & (unknown | unknown);
2578
3143
  /**
@@ -2585,7 +3150,13 @@ export interface components {
2585
3150
  * }
2586
3151
  */
2587
3152
  OtherContact1: {
3153
+ /** @description ChannelType
3154
+ * Method used to contact the financial institution's contact for the specific tax region.
3155
+ * */
2588
3156
  ChanlTp: components["schemas"]["Max4Text"];
3157
+ /** @description Identifier
3158
+ * Communication value such as phone number or email address.
3159
+ * */
2589
3160
  Id?: components["schemas"]["Max128Text"];
2590
3161
  };
2591
3162
  /**
@@ -2636,103 +3207,27 @@ export interface components {
2636
3207
  *
2637
3208
  * @example {
2638
3209
  * "GrpHdr": {
2639
- * "MsgId": 123,
3210
+ * "MsgId": 12345,
2640
3211
  * "CreDtTm": "2020-01-01T00:00:00Z",
2641
- * "NbOfTxs": 1,
2642
- * "SttlmInf": {
2643
- * "SttlmMtd": "INDA",
2644
- * "SttlmDt": "2020-01-01",
2645
- * "SttlmTmIndctn": "RTGS",
2646
- * "SttlmTmReq": "2020-01-01T00:00:00Z",
2647
- * "SttlmAcct": {
2648
- * "Id": {
2649
- * "Othr": {
2650
- * "Id": 123,
2651
- * "SchmeNm": {
2652
- * "Cd": "IBAN"
2653
- * },
2654
- * "Issr": "BIC"
2655
- * }
2656
- * }
2657
- * },
2658
- * "ClrSys": {
2659
- * "Prtry": 123
2660
- * },
2661
- * "InstgAgt": {
2662
- * "FinInstnId": {
2663
- * "BICFI": 123
2664
- * }
2665
- * },
2666
- * "InstdAgt": {
2667
- * "FinInstnId": {
2668
- * "BICFI": 123
2669
- * }
2670
- * }
2671
- * },
2672
- * "InstgAgt": {
2673
- * "FinInstnId": {
2674
- * "BICFI": 123
2675
- * }
2676
- * },
2677
- * "InstdAgt": {
2678
- * "FinInstnId": {
2679
- * "BICFI": 123
2680
- * }
2681
- * },
2682
- * "IntrBkSttlmAmt": {
2683
- * "Amt": 123,
2684
- * "Ccy": "EUR"
2685
- * },
2686
- * "IntrBkSttlmDt": "2020-01-01",
2687
- * "TxSts": "ACCP",
2688
- * "StsRsnInf": {
2689
- * "Orgtr": {
2690
- * "Id": {
2691
- * "Othr": {
2692
- * "Id": 123,
2693
- * "SchmeNm": {
2694
- * "Cd": "IBAN"
2695
- * },
2696
- * "Issr": "BIC"
2697
- * }
2698
- * }
2699
- * },
2700
- * "Rsn": {
2701
- * "Cd": 123,
2702
- * "Prtry": 123
2703
- * }
2704
- * },
2705
3212
  * "TxInfAndSts": {
2706
- * "OrgnlInstrId": 123,
2707
- * "OrgnlEndToEndId": 123,
2708
- * "TxSts": "ACCP",
3213
+ * "StsId": 12345,
3214
+ * "OrgnlInstrId": 12345,
3215
+ * "OrgnlEndToEndId": 12345,
3216
+ * "OrgnlTxId": 12345,
3217
+ * "OrgnlUETR": "123e4567-e89b-12d3-a456-426614174000",
3218
+ * "TxSts": "RJCT",
2709
3219
  * "StsRsnInf": {
2710
- * "Orgtr": {
2711
- * "Id": {
2712
- * "Othr": {
2713
- * "Id": 123,
2714
- * "SchmeNm": {
2715
- * "Cd": "IBAN"
2716
- * },
2717
- * "Issr": "BIC"
2718
- * }
2719
- * }
2720
- * },
2721
- * "Rsn": {
2722
- * "Cd": 123,
2723
- * "Prtry": 123
2724
- * }
2725
- * },
2726
- * "ChrgsInf": {
2727
- * "Amt": 123,
2728
- * "Ccy": "EUR"
2729
- * },
2730
- * "IntrBkSttlmAmt": {
2731
- * "Amt": 123,
2732
- * "Ccy": "EUR"
3220
+ * "Rsn": "RSN",
3221
+ * "AddtlInf": "ADDITIONAL"
2733
3222
  * },
2734
- * "IntrBkSttlmDt": "2020-01-01",
2735
- * "SttlmTmIndctn": "RTGS"
3223
+ * "AccptncDtTm": "2020-01-01T00:00:00Z",
3224
+ * "AcctSvcrRef": "ACCTSVCRREF",
3225
+ * "ClrSysRef": "CLRSYSREF",
3226
+ * "ExctnConf": "1234567890ABCDEF",
3227
+ * "SplmtryData": {
3228
+ * "PlcAndNm": "PLACE",
3229
+ * "Envlp": "ENVELOPE"
3230
+ * }
2736
3231
  * }
2737
3232
  * }
2738
3233
  * }
@@ -2757,12 +3252,18 @@ export interface components {
2757
3252
  * }
2758
3253
  */
2759
3254
  Party38Choice: {
3255
+ /** @description Organisation
3256
+ * Unique and unambiguous way to identify an organisation.
3257
+ * */
2760
3258
  OrgId?: components["schemas"]["OrganisationIdentification29"];
3259
+ /** @description PrivateIdentification
3260
+ * Unique and unambiguous identification of a person, for example a passport.
3261
+ * */
2761
3262
  PrvtId?: components["schemas"]["PersonIdentification13"];
2762
3263
  } & (unknown | unknown);
2763
3264
  /**
2764
3265
  * Party40Choice
2765
- * @description Nature or use of the account.
3266
+ * @description Identification of a person, an organisation or a financial institution.
2766
3267
  *
2767
3268
  * @example {
2768
3269
  * "Pty": {
@@ -2800,12 +3301,18 @@ export interface components {
2800
3301
  * }
2801
3302
  */
2802
3303
  Party40Choice: {
3304
+ /** @description Party
3305
+ * Identification of a person or an organisation.
3306
+ * */
2803
3307
  Pty?: components["schemas"]["PartyIdentification135"];
3308
+ /** @description Agent
3309
+ * Identification of a financial institution.
3310
+ * */
2804
3311
  Agt?: components["schemas"]["BranchAndFinancialInstitutionIdentification6"];
2805
3312
  } & (unknown | unknown);
2806
3313
  /**
2807
3314
  * Party52Choice
2808
- * @description Nature or use of the account.
3315
+ * @description NOTE: Unsure on the description.
2809
3316
  *
2810
3317
  * @example {
2811
3318
  * "OrgId": {
@@ -2820,7 +3327,13 @@ export interface components {
2820
3327
  * }
2821
3328
  */
2822
3329
  Party52Choice: {
3330
+ /** @description Organisation
3331
+ * Unique and unambiguous way to identify an organisation.
3332
+ * */
2823
3333
  OrgId?: components["schemas"]["OrganisationIdentification39"];
3334
+ /** @description Person
3335
+ * Unique and unambiguous identification of a person, for example a passport
3336
+ * */
2824
3337
  PrvtId?: components["schemas"]["PersonIdentification18"];
2825
3338
  } & (unknown | unknown);
2826
3339
  /**
@@ -2830,16 +3343,31 @@ export interface components {
2830
3343
  * @example {
2831
3344
  * "Nm": "John Doe",
2832
3345
  * "PstlAdr": {
2833
- * "Ctry": "BE",
2834
- * "AdrLine": [
2835
- * "Rue du Marché 45",
2836
- * "Brussels",
2837
- * "BE"
2838
- * ]
3346
+ * "AdrTp": "ADDR",
3347
+ * "Dept": "Dept",
3348
+ * "SubDept": "SubDept",
3349
+ * "StrtNm": "StrtNm",
3350
+ * "BldgNb": "BldgNb",
3351
+ * "BldgNm": "BldgNm",
3352
+ * "Flr": "Flr",
3353
+ * "PstBx": "PstBx",
3354
+ * "Room": "Room",
3355
+ * "PstCd": "PstCd",
3356
+ * "TwnNm": "TwnNm",
3357
+ * "TwnLctnNm": "TwnLctnNm",
3358
+ * "DstrctNm": "DstrctNm",
3359
+ * "CtrySubDvsn": "CtrySubDvsn",
3360
+ * "Ctry": "Ctry",
3361
+ * "AdrLine": "AdrLine"
2839
3362
  * },
2840
3363
  * "Id": {
2841
3364
  * "OrgId": {
2842
- * "AnyBIC": "CCCCUS33"
3365
+ * "Othr": {
3366
+ * "Id": 123,
3367
+ * "SchmeNm": {
3368
+ * "Prtry": "DfspId"
3369
+ * }
3370
+ * }
2843
3371
  * }
2844
3372
  * },
2845
3373
  * "CtryOfRes": "BE",
@@ -2849,15 +3377,29 @@ export interface components {
2849
3377
  * "PhneNb": "+123-123-321",
2850
3378
  * "MobNb": "+123-123-321",
2851
3379
  * "FaxNb": "+123-123-321",
2852
- * "EmailAdr": null
3380
+ * "EmailAdr": "example@example.com"
2853
3381
  * }
2854
3382
  * }
2855
3383
  */
2856
3384
  PartyIdentification135: {
3385
+ /** @description Name
3386
+ * Name by which a party is known and which is usually used to identify that party.
3387
+ * */
2857
3388
  Nm?: components["schemas"]["Max140Text"];
3389
+ /** @description PostalAddress
3390
+ * Information that locates and identifies a specific address, as defined by postal services.
3391
+ * */
2858
3392
  PstlAdr?: components["schemas"]["PostalAddress24"];
3393
+ /** @description Identification
3394
+ * Unique and unambiguous way to identify an organisation.
3395
+ * */
2859
3396
  Id?: components["schemas"]["Party38Choice"];
3397
+ /** @description CountryOfResidence Country in which a person resides (the place of a person's home). In the case of a company, it is the country from which the affairs of that company are directed.
3398
+ * */
2860
3399
  CtryOfRes?: components["schemas"]["CountryCode"];
3400
+ /** @description ContactDetails
3401
+ * Set of elements used to indicate how to contact the party.
3402
+ * */
2861
3403
  CtctDtls?: components["schemas"]["Contact4"];
2862
3404
  };
2863
3405
  /**
@@ -2900,10 +3442,25 @@ export interface components {
2900
3442
  * }
2901
3443
  */
2902
3444
  PartyIdentification272: {
3445
+ /** @description Name
3446
+ * Name by which a party is known and which is usually used to identify that party.
3447
+ * */
2903
3448
  Nm?: components["schemas"]["Max140Text"];
3449
+ /** @description Postal Address
3450
+ * Information that locates and identifies a specific address, as defined by postal services.
3451
+ * */
2904
3452
  PstlAdr?: components["schemas"]["PostalAddress27"];
3453
+ /** @description Identification
3454
+ * Unique and unambiguous identification of a party.
3455
+ * */
2905
3456
  Id?: components["schemas"]["Party52Choice"];
3457
+ /** @description Country of Residence
3458
+ * Country in which a person resides (the place of a person's home). In the case of a company, it is the country from which the affairs of that company are directed.
3459
+ * */
2906
3460
  CtryOfRes?: components["schemas"]["CountryCode"];
3461
+ /** @description Contact Details
3462
+ * Set of elements used to indicate how to contact the party.
3463
+ * */
2907
3464
  CtctDtls?: components["schemas"]["Contact13"];
2908
3465
  };
2909
3466
  /**
@@ -2919,10 +3476,30 @@ export interface components {
2919
3476
  * }
2920
3477
  */
2921
3478
  PaymentIdentification13: {
3479
+ /** @description InstructionIdentification
3480
+ * Definition: Unique identification, as assigned by an instructing party for an instructed party, to unambiguously identify the instruction.
3481
+ * Usage: The instruction identification is a point to point reference that can be used between the instructing party and the instructed party to refer to the individual instruction. It can be included in several messages related to the instruction.
3482
+ * */
2922
3483
  InstrId?: components["schemas"]["Max35Text"];
3484
+ /** @description EndToEndIdentification
3485
+ * Definition: Unique identification, as assigned by the initiating party, to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain.
3486
+ * Usage: The end-to-end identification can be used for reconciliation or to link tasks relating to the transaction. It can be included in several messages related to the transaction.
3487
+ * Usage: In case there are technical limitations to pass on multiple references, the end-to-end identification must be passed on throughout the entire end-to-end chain.
3488
+ * */
2923
3489
  EndToEndId: components["schemas"]["Max35Text"];
3490
+ /** @description TransactionIdentification
3491
+ * Definition: Unique identification, as assigned by the first instructing agent, to unambiguously identify the transaction that is passed on, unchanged, throughout the entire interbank chain.
3492
+ * Usage: The transaction identification can be used for reconciliation, tracking or to link tasks relating to the transaction on the interbank level.
3493
+ * Usage: The instructing agent has to make sure that the transaction identification is unique for a preagreed period.
3494
+ * */
2924
3495
  TxId?: components["schemas"]["Max35Text"];
3496
+ /** @description UETR
3497
+ * Universally unique identifier to provide an end-to-end reference of a payment transaction.
3498
+ * */
2925
3499
  UETR?: components["schemas"]["UUIDv4Identifier"];
3500
+ /** @description ClearingSystemReference
3501
+ * Unique reference, as assigned by a clearing system, to unambiguously identify the instruction.
3502
+ * */
2926
3503
  ClrSysRef?: components["schemas"]["Max35Text"];
2927
3504
  };
2928
3505
  /**
@@ -2983,10 +3560,26 @@ export interface components {
2983
3560
  * }
2984
3561
  */
2985
3562
  PaymentTypeInformation28: {
3563
+ /** @description InstructionPriority
3564
+ * Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction.
3565
+ * */
2986
3566
  InstrPrty?: components["schemas"]["Priority2Code"];
3567
+ /** @description ClearingChannel
3568
+ * Specifies the clearing channel to be used to process the payment instruction.
3569
+ * */
2987
3570
  ClrChanl?: components["schemas"]["ClearingChannel2Code"];
3571
+ /** @description ServiceLevel
3572
+ * Agreement under which or rules under which the transaction should be processed.
3573
+ * */
2988
3574
  SvcLvl?: components["schemas"]["ServiceLevel8Choice"];
3575
+ /** @description LocalInstrument
3576
+ * Definition: User community specific instrument.
3577
+ * Usage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.
3578
+ * */
2989
3579
  LclInstrm?: components["schemas"]["LocalInstrument2Choice"];
3580
+ /** @description CategoryPurpose
3581
+ * Specifies the high level purpose of the instruction based on a set of pre-defined categories.
3582
+ * */
2990
3583
  CtgyPurp?: components["schemas"]["CategoryPurpose1Choice"];
2991
3584
  };
2992
3585
  /**
@@ -3013,7 +3606,13 @@ export interface components {
3013
3606
  * }
3014
3607
  */
3015
3608
  PersonIdentification13: {
3609
+ /** @description DateAndPlaceOfBirth
3610
+ * Date and place of birth of a person.
3611
+ * */
3016
3612
  DtAndPlcOfBirth?: components["schemas"]["DateAndPlaceOfBirth1"];
3613
+ /** @description Other
3614
+ * Unique identification of a person, as assigned by an institution, using an identification scheme.
3615
+ * */
3017
3616
  Othr?: components["schemas"]["GenericPersonIdentification1"];
3018
3617
  };
3019
3618
  /**
@@ -3035,7 +3634,13 @@ export interface components {
3035
3634
  * }
3036
3635
  */
3037
3636
  PersonIdentification18: {
3637
+ /** @description DateAndPlaceOfBirth
3638
+ * Date and place of birth of a person.
3639
+ * */
3038
3640
  DtAndPlcOfBirth?: components["schemas"]["DateAndPlaceOfBirth1"];
3641
+ /** @description Other
3642
+ * Unique identification of a person, as assigned by an institution, using an identification scheme.
3643
+ * */
3039
3644
  Othr?: components["schemas"]["GenericPersonIdentification2"];
3040
3645
  };
3041
3646
  /**
@@ -3047,7 +3652,13 @@ export interface components {
3047
3652
  * }
3048
3653
  */
3049
3654
  PersonIdentificationSchemeName1Choice: {
3655
+ /** @description Code
3656
+ * Name of the identification scheme, in a coded form as published in an external list
3657
+ * */
3050
3658
  Cd?: components["schemas"]["ExternalPersonIdentification1Code"];
3659
+ /** @description Proprietary
3660
+ * Name of the identification scheme, in a free text form
3661
+ * */
3051
3662
  Prtry?: components["schemas"]["Max35Text"];
3052
3663
  } & (unknown | unknown);
3053
3664
  /**
@@ -3178,19 +3789,37 @@ export interface components {
3178
3789
  * }
3179
3790
  */
3180
3791
  ProxyAccountIdentification1: {
3792
+ /** @description Type
3793
+ *
3794
+ * Type of the proxy identification.
3795
+ * */
3181
3796
  Tp?: components["schemas"]["ProxyAccountType1Choice"];
3797
+ /** @description Identification
3798
+ *
3799
+ * Identification used to indicate the account identification under another specified name.
3800
+ * */
3182
3801
  Id: components["schemas"]["Max2048Text"];
3183
3802
  };
3184
3803
  /**
3185
3804
  * ProxyAccountType1Choice
3186
- * @description NOTE: Unsure on description.
3805
+ * @description ProxyAccountType1Choice
3806
+ *
3807
+ * Specifies the scheme used for the identification of an account alias.
3187
3808
  *
3188
3809
  * @example {
3189
3810
  * "Cd": "CH03"
3190
3811
  * }
3191
3812
  */
3192
3813
  ProxyAccountType1Choice: {
3814
+ /** @description Code
3815
+ *
3816
+ * Name of the identification scheme, in a coded form as published in an external list.
3817
+ * */
3193
3818
  Cd?: components["schemas"]["ExternalProxyAccountType1Code"];
3819
+ /** @description Proprietary
3820
+ *
3821
+ * Name of the identification scheme, in a free text form.
3822
+ * */
3194
3823
  Prtry?: components["schemas"]["Max35Text"];
3195
3824
  } & (unknown | unknown);
3196
3825
  /**
@@ -3203,7 +3832,15 @@ export interface components {
3203
3832
  * }
3204
3833
  */
3205
3834
  Purpose2Choice: {
3835
+ /** @description Code
3836
+ *
3837
+ * Underlying reason for the payment transaction, as published in an external purpose code list.
3838
+ * */
3206
3839
  Cd?: components["schemas"]["ExternalPurpose1Code"];
3840
+ /** @description Proprietary
3841
+ *
3842
+ * Purpose, in a proprietary form.
3843
+ * */
3207
3844
  Prtry?: components["schemas"]["Max35Text"];
3208
3845
  } & (unknown | unknown);
3209
3846
  /**
@@ -3216,7 +3853,15 @@ export interface components {
3216
3853
  * }
3217
3854
  */
3218
3855
  RegulatoryAuthority2: {
3856
+ /** @description Name
3857
+ *
3858
+ * Name of the entity requiring the regulatory reporting information.
3859
+ * */
3219
3860
  Nm?: components["schemas"]["Max140Text"];
3861
+ /** @description Country
3862
+ *
3863
+ * Country of the entity that requires the regulatory reporting information.
3864
+ * */
3220
3865
  Ctry?: components["schemas"]["CountryCode"];
3221
3866
  };
3222
3867
  /**
@@ -3236,9 +3881,19 @@ export interface components {
3236
3881
  * }
3237
3882
  */
3238
3883
  RegulatoryReporting3: {
3884
+ /** @description DebitCreditReportingIndicator
3885
+ * Identifies whether the regulatory reporting information applies to the debit side, to the credit side or to both debit and credit sides of the transaction.
3886
+ * */
3239
3887
  DbtCdtRptgInd?: components["schemas"]["RegulatoryReportingType1Code"];
3888
+ /** @description Authority
3889
+ *
3890
+ * Entity requiring the regulatory reporting information.
3891
+ * */
3240
3892
  Authrty?: components["schemas"]["RegulatoryAuthority2"];
3241
- Dtls?: components["schemas"]["StructuredRegulatoryReporting3"];
3893
+ /** @description Details
3894
+ * Identifies whether the regulatory reporting information applies to the debit side, to the credit side or to both debit and credit sides of the transaction.
3895
+ * */
3896
+ Dtls?: components["schemas"]["StructuredRegulatoryReporting3"] | components["schemas"]["StructuredRegulatoryReporting3"][];
3242
3897
  };
3243
3898
  /**
3244
3899
  * RegulatoryReportingType1Code
@@ -3257,12 +3912,19 @@ export interface components {
3257
3912
  * }
3258
3913
  */
3259
3914
  ServiceLevel8Choice: {
3915
+ /** @description Code
3916
+ * Specifies a pre-agreed service or level of service between the parties, as published in an external service level code list.
3917
+ * */
3260
3918
  Cd?: components["schemas"]["ExternalServiceLevel1Code"];
3919
+ /** @description Proprietary
3920
+ * Specifies a pre-agreed service or level of service between the parties, as a proprietary code.
3921
+ * */
3261
3922
  Prtry?: components["schemas"]["Max35Text"];
3262
3923
  } & (unknown | unknown);
3263
3924
  /**
3264
3925
  * SettlementInstruction15
3265
- * @description NOTE: Unsure on description.
3926
+ * @description Specifies the details on how the settlement of the original transaction(s) between the
3927
+ * instructing agent and the instructed agent was completed.
3266
3928
  *
3267
3929
  * @example {
3268
3930
  * "SttlmMtd": "INDA",
@@ -3307,7 +3969,12 @@ export interface components {
3307
3969
  * }
3308
3970
  */
3309
3971
  SettlementInstruction15: {
3972
+ /** @description SettlementMethod
3973
+ * Method used to settle the (batch of) payment instructions.
3974
+ * */
3310
3975
  SttlmMtd: components["schemas"]["SettlementMethod1Code"];
3976
+ /** @description PaymentTypeInformation
3977
+ * */
3311
3978
  PmtTpInf?: components["schemas"]["PaymentTypeInformation28"];
3312
3979
  };
3313
3980
  /**
@@ -3327,7 +3994,13 @@ export interface components {
3327
3994
  * }
3328
3995
  */
3329
3996
  StatusReason6Choice: {
3997
+ /** @description Code
3998
+ * Reason for the status, as published in an external reason code list.
3999
+ * */
3330
4000
  Cd?: components["schemas"]["ExternalStatusReason1Code"];
4001
+ /** @description Proprietary
4002
+ * Reason for the status, in a proprietary form.
4003
+ * */
3331
4004
  Prtry?: components["schemas"]["Max35Text"];
3332
4005
  } & (unknown | unknown);
3333
4006
  /**
@@ -3356,13 +4029,21 @@ export interface components {
3356
4029
  * }
3357
4030
  */
3358
4031
  StatusReasonInformation14: {
4032
+ /** @description Originator
4033
+ * Party that issues the status. */
3359
4034
  Orgtr?: components["schemas"]["PartyIdentification272"];
4035
+ /** @description Reason
4036
+ * Specifies the reason for the status report. */
3360
4037
  Rsn?: components["schemas"]["StatusReason6Choice"];
4038
+ /** @description AdditionalInformation
4039
+ * Additional information about the status report. */
3361
4040
  AddtlInf?: components["schemas"]["Max105Text"];
3362
4041
  };
3363
4042
  /**
3364
4043
  * StructuredRegulatoryReporting3
3365
- * @description Unsure on description.
4044
+ * @description StructuredRegulatoryReporting3
4045
+ *
4046
+ * Information needed due to regulatory and statutory requirements.
3366
4047
  *
3367
4048
  * @example {
3368
4049
  * "Tp": "T1",
@@ -3377,12 +4058,34 @@ export interface components {
3377
4058
  * }
3378
4059
  */
3379
4060
  StructuredRegulatoryReporting3: {
4061
+ /** @description Type
4062
+ *
4063
+ * Specifies the type of the information supplied in the regulatory reporting details.
4064
+ * */
3380
4065
  Tp?: components["schemas"]["Max35Text"];
4066
+ /** @description Date
4067
+ *
4068
+ * Date related to the specified type of regulatory reporting details.
4069
+ * */
3381
4070
  Dt?: components["schemas"]["ISODate"];
4071
+ /** @description Country
4072
+ *
4073
+ * Country related to the specified type of regulatory reporting details.
4074
+ * */
3382
4075
  Ctry?: components["schemas"]["CountryCode"];
4076
+ /** @description Code
4077
+ * Specifies the nature, purpose, and reason for the transaction to be reported for regulatory and statutory requirements in a coded form.
4078
+ * */
3383
4079
  Cd?: components["schemas"]["Max10Text"];
4080
+ /** @description Amount
4081
+ *
4082
+ * Amount of money to be reported for regulatory and statutory requirements.
4083
+ * */
3384
4084
  Amt?: components["schemas"]["ActiveOrHistoricCurrencyAndAmount"];
3385
- Inf?: components["schemas"]["Max35Text"];
4085
+ /** @description Information
4086
+ * Additional details that cater for specific domestic regulatory requirements.
4087
+ * */
4088
+ Inf?: components["schemas"]["Max35Text"] | components["schemas"]["Max35Text"][];
3386
4089
  };
3387
4090
  /**
3388
4091
  * SupplementaryData1
@@ -3397,12 +4100,20 @@ export interface components {
3397
4100
  * }
3398
4101
  */
3399
4102
  SupplementaryData1: {
4103
+ /** @description PlaceAndName
4104
+ * Unambiguous reference to the location where the supplementary data must be inserted in the message instance.
4105
+ * */
3400
4106
  PlcAndNm?: components["schemas"]["Max350Text"];
4107
+ /** @description Envelope
4108
+ * Technical element wrapping the supplementary data.
4109
+ * Technical component that contains the validated supplementary data information. This technical envelope allows to segregate the supplementary data information from any other information.
4110
+ * */
3401
4111
  Envlp: components["schemas"]["SupplementaryDataEnvelope1"];
3402
4112
  };
3403
4113
  /**
3404
4114
  * SupplementaryDataEnvelope1
3405
- * @description Unsure on description.
4115
+ * @description SupplementaryDataEnvelope1
4116
+ * Technical component that contains the validated supplementary data information. This technical envelope allows to segregate the supplementary data information from any other information.
3406
4117
  *
3407
4118
  */
3408
4119
  SupplementaryDataEnvelope1: Record<string, never>;
@@ -3433,10 +4144,26 @@ export interface components {
3433
4144
  * }
3434
4145
  */
3435
4146
  TaxAmount3: {
4147
+ /** @description Rate
4148
+ *
4149
+ * Rate used to calculate the tax.
4150
+ * */
3436
4151
  Rate?: components["schemas"]["PercentageRate"];
4152
+ /** @description TaxableBaseAmount
4153
+ *
4154
+ * Amount of money on which the tax is based.
4155
+ * */
3437
4156
  TaxblBaseAmt?: components["schemas"]["ActiveOrHistoricCurrencyAndAmount"];
4157
+ /** @description TotalAmount
4158
+ *
4159
+ * Total amount that is the result of the calculation of the tax for the record.
4160
+ * */
3438
4161
  TtlAmt?: components["schemas"]["ActiveOrHistoricCurrencyAndAmount"];
3439
- Dtls?: components["schemas"]["TaxRecordDetails3"];
4162
+ /** @description Details
4163
+ *
4164
+ * Set of elements used to provide details on the tax period and amount.
4165
+ * */
4166
+ Dtls?: components["schemas"]["TaxRecordDetails3"] | components["schemas"]["TaxRecordDetails3"][];
3440
4167
  };
3441
4168
  /**
3442
4169
  * TaxAuthorisation1
@@ -3448,7 +4175,15 @@ export interface components {
3448
4175
  * }
3449
4176
  */
3450
4177
  TaxAuthorisation1: {
4178
+ /** @description Title
4179
+ *
4180
+ * Title or position of debtor or the debtor's authorised representative.
4181
+ * */
3451
4182
  Titl?: components["schemas"]["Max35Text"];
4183
+ /** @description Name
4184
+ *
4185
+ * Name of the debtor or the debtor's authorised representative.
4186
+ * */
3452
4187
  Nm?: components["schemas"]["Max140Text"];
3453
4188
  };
3454
4189
  /**
@@ -3494,17 +4229,61 @@ export interface components {
3494
4229
  * }
3495
4230
  */
3496
4231
  TaxData1: {
4232
+ /** @description Creditor
4233
+ *
4234
+ * Party on the credit side of the transaction to which the tax applies.
4235
+ * */
3497
4236
  Cdtr?: components["schemas"]["TaxParty1"];
4237
+ /** @description Debtor
4238
+ *
4239
+ * Party on the debit side of the transaction to which the tax applies.
4240
+ * */
3498
4241
  Dbtr?: components["schemas"]["TaxParty2"];
4242
+ /** @description UltimateDebtor
4243
+ *
4244
+ * Ultimate party that owes an amount of money to the (ultimate) creditor, in this case, to the taxing authority.
4245
+ * */
3499
4246
  UltmtDbtr?: components["schemas"]["TaxParty2"];
4247
+ /** @description AdministrationZone
4248
+ *
4249
+ * Territorial part of a country to which the tax payment is related.
4250
+ * */
3500
4251
  AdmstnZone?: components["schemas"]["Max35Text"];
4252
+ /** @description ReferenceNumber
4253
+ *
4254
+ * Tax reference information that is specific to a taxing agency.
4255
+ * */
3501
4256
  RefNb?: components["schemas"]["Max140Text"];
4257
+ /** @description Method
4258
+ *
4259
+ * Method used to indicate the underlying business or how the tax is paid.
4260
+ * */
3502
4261
  Mtd?: components["schemas"]["Max35Text"];
4262
+ /** @description TotalTaxableBaseAmount
4263
+ *
4264
+ * Total amount of money on which the tax is based.
4265
+ * */
3503
4266
  TtlTaxblBaseAmt?: components["schemas"]["ActiveOrHistoricCurrencyAndAmount"];
4267
+ /** @description TotalTaxAmount
4268
+ *
4269
+ * Total amount of money as result of the calculation of the tax.
4270
+ * */
3504
4271
  TtlTaxAmt?: components["schemas"]["ActiveOrHistoricCurrencyAndAmount"];
4272
+ /** @description Date
4273
+ *
4274
+ * Date by which tax is due.
4275
+ * */
3505
4276
  Dt?: components["schemas"]["ISODate"];
4277
+ /** @description SequenceNumber
4278
+ *
4279
+ * Sequential number of the tax report
4280
+ * */
3506
4281
  SeqNb?: components["schemas"]["Number"];
3507
- Rcrd?: components["schemas"]["TaxRecord3"];
4282
+ /** @description Record
4283
+ *
4284
+ * Details of the tax record.
4285
+ * */
4286
+ Rcrd?: components["schemas"]["TaxRecord3"] | components["schemas"]["TaxRecord3"][];
3508
4287
  };
3509
4288
  /**
3510
4289
  * TaxParty1
@@ -3517,8 +4296,20 @@ export interface components {
3517
4296
  * }
3518
4297
  */
3519
4298
  TaxParty1: {
4299
+ /** @description TaxIdentification
4300
+ *
4301
+ * Tax identification number of the creditor.
4302
+ * */
3520
4303
  TaxId?: components["schemas"]["Max35Text"];
4304
+ /** @description RegistrationIdentification
4305
+ *
4306
+ * Unique identification, as assigned by an organisation, to unambiguously identify a party.
4307
+ * */
3521
4308
  RegnId?: components["schemas"]["Max35Text"];
4309
+ /** @description TaxType
4310
+ *
4311
+ * Type of tax payer.
4312
+ * */
3522
4313
  TaxTp?: components["schemas"]["Max35Text"];
3523
4314
  };
3524
4315
  /**
@@ -3536,9 +4327,25 @@ export interface components {
3536
4327
  * }
3537
4328
  */
3538
4329
  TaxParty2: {
4330
+ /** @description TaxIdentification
4331
+ *
4332
+ * Tax identification number of the debtor.
4333
+ * */
3539
4334
  TaxId?: components["schemas"]["Max35Text"];
4335
+ /** @description RegistrationIdentification
4336
+ *
4337
+ * Unique identification, as assigned by an organisation, to unambiguously identify a party.
4338
+ * */
3540
4339
  RegnId?: components["schemas"]["Max35Text"];
4340
+ /** @description TaxType
4341
+ *
4342
+ * Type of tax payer.
4343
+ * */
3541
4344
  TaxTp?: components["schemas"]["Max35Text"];
4345
+ /** @description Authorisation
4346
+ *
4347
+ * Details of the authorised tax paying party.
4348
+ * */
3542
4349
  Authstn?: components["schemas"]["TaxAuthorisation1"];
3543
4350
  };
3544
4351
  /**
@@ -3555,9 +4362,21 @@ export interface components {
3555
4362
  * }
3556
4363
  */
3557
4364
  TaxPeriod3: {
3558
- Yr?: components["schemas"]["ISOYear"];
3559
- Tp?: components["schemas"]["TaxRecordPeriod1Code"];
4365
+ /** @description FromToDate
4366
+ *
4367
+ * Range of time between a start date and an end date for which the tax report is provided.
4368
+ * */
3560
4369
  FrToDt?: components["schemas"]["DatePeriod2"];
4370
+ /** @description Type
4371
+ *
4372
+ * Identification of the period related to the tax payment.
4373
+ * */
4374
+ Tp?: components["schemas"]["TaxRecordPeriod1Code"];
4375
+ /** @description Year
4376
+ *
4377
+ * Year related to the tax payment.
4378
+ * */
4379
+ Yr?: components["schemas"]["ISOYear"];
3561
4380
  };
3562
4381
  /**
3563
4382
  * TaxRecord3
@@ -3583,15 +4402,51 @@ export interface components {
3583
4402
  * }
3584
4403
  */
3585
4404
  TaxRecord3: {
3586
- Tp?: components["schemas"]["Max35Text"];
4405
+ /** @description AdditionalInformation
4406
+ *
4407
+ * Further details of the tax record.
4408
+ * */
4409
+ AddtlInf?: components["schemas"]["Max140Text"];
4410
+ /** @description CertificateIdentification
4411
+ *
4412
+ * Identification number of the tax report as assigned by the taxing authority.
4413
+ * */
4414
+ CertId?: components["schemas"]["Max35Text"];
4415
+ /** @description Category
4416
+ *
4417
+ * Specifies the tax code as published by the tax authority.
4418
+ * */
3587
4419
  Ctgy?: components["schemas"]["Max35Text"];
4420
+ /** @description CategoryDetails
4421
+ *
4422
+ * Provides further details of the category tax code.
4423
+ * */
3588
4424
  CtgyDtls?: components["schemas"]["Max35Text"];
4425
+ /** @description DebtorStatus
4426
+ *
4427
+ * Code provided by local authority to identify the status of the party that has drawn up the settlement document.
4428
+ * */
3589
4429
  DbtrSts?: components["schemas"]["Max35Text"];
3590
- CertId?: components["schemas"]["Max35Text"];
4430
+ /** @description FormsCode
4431
+ *
4432
+ * Identifies, in a coded form, on which template the tax report is to be provided.
4433
+ * */
3591
4434
  FrmsCd?: components["schemas"]["Max35Text"];
4435
+ /** @description Period
4436
+ *
4437
+ * Set of elements used to provide details on the period of time related to the tax payment.
4438
+ * */
3592
4439
  Prd?: components["schemas"]["TaxPeriod3"];
4440
+ /** @description TaxAmount
4441
+ *
4442
+ * Set of elements used to provide information on the amount of the tax record.
4443
+ * */
3593
4444
  TaxAmt?: components["schemas"]["TaxAmount3"];
3594
- AddtlInf?: components["schemas"]["Max140Text"];
4445
+ /** @description Type
4446
+ *
4447
+ * High level code to identify the type of tax details.
4448
+ * */
4449
+ Tp?: components["schemas"]["Max35Text"];
3595
4450
  };
3596
4451
  /**
3597
4452
  * TaxRecordDetails3
@@ -3613,7 +4468,15 @@ export interface components {
3613
4468
  * }
3614
4469
  */
3615
4470
  TaxRecordDetails3: {
4471
+ /** @description Period
4472
+ *
4473
+ * Set of elements used to provide details on the period of time related to the tax payment.
4474
+ * */
3616
4475
  Prd?: components["schemas"]["TaxPeriod3"];
4476
+ /** @description Amount
4477
+ *
4478
+ * Underlying tax amount related to the specified period.
4479
+ * */
3617
4480
  Amt: components["schemas"]["ActiveOrHistoricCurrencyAndAmount"];
3618
4481
  };
3619
4482
  /**
@@ -3726,36 +4589,88 @@ export interface components {
3726
4589
  * }
3727
4590
  */
3728
4591
  VerificationReason1Choice: {
4592
+ /** @description Code
4593
+ * Reason why the verified identification information is incorrect, as published in an external reason code list.
4594
+ * */
3729
4595
  Cd?: components["schemas"]["ExternalVerificationReason1Code"];
4596
+ /** @description Proprietary
4597
+ * Reason why the verified identification information is incorrect, in a free text form.
4598
+ * */
3730
4599
  Prtry?: components["schemas"]["Max35Text"];
3731
4600
  } & (unknown | unknown);
3732
4601
  /**
3733
4602
  * VerificationReport4
3734
4603
  * @example {
3735
- * "OrgnlId": 123456789,
4604
+ * "OrgnlId": 1.2345678901234568e+33,
3736
4605
  * "Vrfctn": true,
3737
- * "Rsn": {
3738
- * "Cd": "AGNT"
3739
- * },
3740
4606
  * "OrgnlPtyAndAcctId": {
3741
- * "Id": 123456789,
3742
- * "SchmeNm": {
3743
- * "Cd": "CCPT"
4607
+ * "Nm": "John Doe",
4608
+ * "PstlAdr": {
4609
+ * "AdrTp": "ADDR",
4610
+ * "Dept": "Dept",
4611
+ * "SubDept": "SubDept",
4612
+ * "StrtNm": "1234 Elm St",
4613
+ * "BldgNb": 1234,
4614
+ * "PstCd": 12345,
4615
+ * "TwnNm": "Anytown",
4616
+ * "CtrySubDvsn": "CA",
4617
+ * "Ctry": "US"
4618
+ * },
4619
+ * "Id": {
4620
+ * "OrgId": {
4621
+ * "AnyBIC": "ABCDUS33",
4622
+ * "Othr": {
4623
+ * "Id": 123456789,
4624
+ * "Issr": "ABA"
4625
+ * }
4626
+ * }
3744
4627
  * }
3745
4628
  * },
3746
4629
  * "UpdtdPtyAndAcctId": {
3747
- * "Id": 123456789,
3748
- * "SchmeNm": {
3749
- * "Cd": "CCPT"
4630
+ * "Nm": "John Doe",
4631
+ * "PstlAdr": {
4632
+ * "AdrTp": "ADDR",
4633
+ * "Dept": "Dept",
4634
+ * "SubDept": "SubDept",
4635
+ * "StrtNm": "1234 Elm St",
4636
+ * "BldgNb": 1234,
4637
+ * "PstCd": 12345,
4638
+ * "TwnNm": "Anytown",
4639
+ * "CtrySubDvsn": "CA",
4640
+ * "Ctry": "US"
4641
+ * },
4642
+ * "Id": {
4643
+ * "OrgId": {
4644
+ * "AnyBIC": "ABCDUS33",
4645
+ * "Othr": {
4646
+ * "Id": 123456789,
4647
+ * "Issr": "ABA"
4648
+ * }
4649
+ * }
3750
4650
  * }
3751
4651
  * }
3752
4652
  * }
3753
4653
  */
3754
4654
  VerificationReport4: {
4655
+ /** @description OriginalIdentification
4656
+ * Unique identification, as assigned by a sending party, to unambiguously identify the party and account identification information group within the original message.
4657
+ * */
3755
4658
  OrgnlId: components["schemas"]["Max35Text"];
4659
+ /** @description Verification
4660
+ * Identifies whether the party and/or account information received is correct. Boolean value.
4661
+ * */
3756
4662
  Vrfctn: components["schemas"]["IdentificationVerificationIndicator"];
4663
+ /** @description Reason.
4664
+ * Specifies the reason why the verified identification information is incorrect.
4665
+ * */
3757
4666
  Rsn?: components["schemas"]["VerificationReason1Choice"];
4667
+ /** @description OriginalPartyAndAccountIdentification
4668
+ * Provides party and/or account identification information as given in the original message.
4669
+ * */
3758
4670
  OrgnlPtyAndAcctId?: components["schemas"]["IdentificationInformation4"];
4671
+ /** @description UpdatedPartyAndAccountIdentification
4672
+ * Provides party and/or account identification information.
4673
+ * */
3759
4674
  UpdtdPtyAndAcctId?: components["schemas"]["IdentificationInformation4"];
3760
4675
  };
3761
4676
  /**