npm - @mojaloop/api-snippets - Versions diffs - 17.6.0-snapshot.0 → 17.6.0 - Mend

@mojaloop/api-snippets 17.6.0-snapshot.0 → 17.6.0

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 (253) hide show

package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Exact4AlphaNumericText.yaml ADDED Viewed

@@ -0,0 +1,6 @@
+title: Exact4AlphaNumericText
+description: |
+  Specifies an alphanumeric string with a length of 4 characters.
+type: string
+pattern: ^[a-zA-Z0-9]{4}$
+example: 1234

package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Execute_FIToFICustomerCreditTransferV13.yaml ADDED Viewed

@@ -0,0 +1,61 @@
+title: Execute_FIToFICustomerCreditTransferV13
+type: object
+properties:
+  GrpHdr:
+    $ref: ./GroupHeader129.yaml
+  CdtTrfTxInf:
+    $ref: ./CreditTransferTransaction67.yaml
+required:
+  - GrpHdr
+  - CdtTrfTxInf
+example:
+  GrpHdr:
+    MsgId: 123456789
+    CreDtTm: 2020-01-01T00:00:00Z
+    NbOfTxs: 1
+    CtrlSum: 100.00
+    InitgPty:
+      Nm: Initiating Party Name
+      Id:
+        OrgId:
+          Othr:
+            - Id: 123456789
+              SchmeNm:
+                Cd: 91
+    FwdgAgt:
+      FinInstnId:
+        BICFI: BBBBBBBB
+  CdtTrfTxInf:
+    PmtId:
+      InstrId: 123456789
+      EndToEndId: 123456789
+    PmtTpInf:
+      InstrPrty: NORM
+      CtgyPurp:
+        Cd: SUPP
+    InstrForCdtrAgt:
+      FinInstnId:
+        BICFI: AAAAAAAA
+    CdtrAgt:
+      FinInstnId:
+        BICFI: AAAAAAAA
+    Cdtr:
+      Nm: Creditor Name
+      PstlAdr:
+        AdrLine:
+          - Creditor Address Line 1
+          - Creditor Address Line 2
+          - Creditor Address Line 3
+          - Creditor Address Line 4
+          - Creditor Address Line 5
+      Id:
+        OrgId:
+          Othr:
+            - Id: 123456789
+              SchmeNm:
+                Cd: 91
+    CdtrAcct:
+      Id:
+        IBAN: DE87123456781234567890
+    RmtInf:
+      Ustrd: Remittance Information

package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Extension.yaml ADDED Viewed

@@ -0,0 +1,11 @@
+title: Extension
+type: object
+description: Data model for the complex type Extension.
+properties:
+  key:
+    $ref: ./ExtensionKey.yaml
+  value:
+    $ref: ./ExtensionValue.yaml
+required:
+  - key
+  - value

package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExtensionKey.yaml ADDED Viewed

@@ -0,0 +1,5 @@
+title: ExtensionKey
+type: string
+minLength: 1
+maxLength: 32
+description: Extension key.

package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExtensionList.yaml ADDED Viewed

@@ -0,0 +1,15 @@
+title: ExtensionList
+type: object
+description: >
+  Data model for the complex type ExtensionList. An optional list of extensions,
+  specific to deployment.
+properties:
+  extension:
+    type: array
+    items:
+      $ref: ./Extension.yaml
+    minItems: 1
+    maxItems: 16
+    description: Number of Extension elements.
+required:
+  - extension

package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExtensionValue.yaml ADDED Viewed

@@ -0,0 +1,5 @@
+title: ExtensionValue
+type: string
+minLength: 1
+maxLength: 128
+description: Extension value.

package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalAccountIdentification1Code.yaml ADDED Viewed

@@ -0,0 +1,8 @@
+title: ExternalAccountIdentification1Code
+description: >
+  Specifies the external account identification scheme name code in the format
+  of character string with a maximum length of 4 characters.
+type: string
+minLength: 1
+maxLength: 4
+example: 1234

package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalCashAccountType1Code.yaml ADDED Viewed

@@ -0,0 +1,8 @@
+title: ExternalCashAccountType1Code
+description: >
+  Specifies the nature, or use, of the cash account in the format of character
+  string with a maximum length of 4 characters.
+type: string
+minLength: 1
+maxLength: 4
+example: 1234

package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalCategoryPurpose1Code.yaml ADDED Viewed

@@ -0,0 +1,9 @@
+description: >
+  Specifies the category purpose, as published in an external category purpose
+  code list.
+  External code sets can be downloaded from www.iso20022.org.
+maxLength: 4
+minLength: 1
+type: string
+example: 1234

package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalChargeType1Code.yaml ADDED Viewed

@@ -0,0 +1,5 @@
+title: ExternalChargeType1Code
+type: string
+minLength: 1
+maxLength: 4
+example: 1234

package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalClearingSystemIdentification1Code.yaml ADDED Viewed

@@ -0,0 +1,5 @@
+title: ExternalClearingSystemIdentification1Code
+type: string
+minLength: 1
+maxLength: 5
+example: 12345

package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalCreditorAgentInstruction1Code.yaml ADDED Viewed

@@ -0,0 +1,5 @@
+title: ExternalCreditorAgentInstruction1Code
+type: string
+minLength: 1
+maxLength: 4
+example: 1234

package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalFinancialInstitutionIdentification1Code.yaml ADDED Viewed

@@ -0,0 +1,5 @@
+title: ExternalFinancialInstitutionIdentification1Code
+type: string
+minLength: 1
+maxLength: 4
+example: 1234

package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalLocalInstrument1Code.yaml ADDED Viewed

@@ -0,0 +1,5 @@
+title: ExternalLocalInstrument1Code
+type: string
+minLength: 1
+maxLength: 35
+example: 12345

package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalOrganisationIdentification1Code.yaml ADDED Viewed

@@ -0,0 +1,5 @@
+title: ExternalOrganisationIdentification1Code
+type: string
+minLength: 1
+maxLength: 4
+example: 1234

package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalPaymentTransactionStatus1Code.yaml ADDED Viewed

@@ -0,0 +1,5 @@
+title: ExternalPaymentTransactionStatus1Code
+type: string
+minLength: 1
+maxLength: 4
+example: 1234

package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalPersonIdentification1Code.yaml ADDED Viewed

@@ -0,0 +1,5 @@
+title: ExternalPersonIdentification1Code
+type: string
+minLength: 1
+maxLength: 4
+example: 1234

package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalProxyAccountType1Code.yaml ADDED Viewed

@@ -0,0 +1,5 @@
+title: ExternalProxyAccountType1Code
+type: string
+minLength: 1
+maxLength: 4
+example: 1234

package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalPurpose1Code.yaml ADDED Viewed

@@ -0,0 +1,5 @@
+title: ExternalPurpose1Code
+type: string
+minLength: 1
+maxLength: 4
+example: 1234

package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalServiceLevel1Code.yaml ADDED Viewed

@@ -0,0 +1,5 @@
+title: ExternalServiceLevel1Code
+type: string
+minLength: 1
+maxLength: 4
+example: 1234

package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalStatusReason1Code.yaml ADDED Viewed

@@ -0,0 +1,5 @@
+title: ExternalStatusReason1Code
+type: string
+minLength: 1
+maxLength: 4
+example: 1234

package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalVerificationReason1Code.yaml ADDED Viewed

@@ -0,0 +1,5 @@
+title: ExternalVerificationReason1Code
+type: string
+minLength: 1
+maxLength: 4
+example: 1234

package/fspiop/v2_0_ISO20022/openapi3/components/schemas/FinancialIdentificationSchemeName1Choice.yaml ADDED Viewed

@@ -0,0 +1,14 @@
+title: FinancialIdentificationSchemeName1Choice
+type: object
+properties:
+  Cd:
+    $ref: ./ExternalFinancialInstitutionIdentification1Code.yaml
+  Prtry:
+    $ref: ./Max35Text.yaml
+oneOf:
+  - required:
+      - Cd
+  - required:
+      - Prtry
+example:
+  Cd: BIC

package/fspiop/v2_0_ISO20022/openapi3/components/schemas/FinancialInstitutionIdentification18.yaml ADDED Viewed

@@ -0,0 +1,24 @@
+title: FinancialInstitutionIdentification18
+type: object
+properties:
+  BICFI:
+    $ref: ./BICFIDec2014Identifier.yaml
+  ClrSysMmbId:
+    $ref: ./ClearingSystemMemberIdentification2.yaml
+  LEI:
+    $ref: ./LEIIdentifier.yaml
+  Nm:
+    $ref: ./Max140Text.yaml
+  PstlAdr:
+    $ref: ./PostalAddress24.yaml
+  Othr:
+    $ref: ./GenericFinancialIdentification1.yaml
+example:
+  BICFI: BUKBGB22
+  Nm: Barclays Bank Plc
+  PstlAdr:
+    Ctry: GB
+    AdrLine:
+      - 1 Churchill Place
+      - London
+      - UK

package/fspiop/v2_0_ISO20022/openapi3/components/schemas/FinancialInstitutionIdentification23.yaml ADDED Viewed

@@ -0,0 +1,24 @@
+title: FinancialInstitutionIdentification23
+type: object
+properties:
+  BICFI:
+    $ref: ./BICFIDec2014Identifier.yaml
+  ClrSysMmbId:
+    $ref: ./ClearingSystemMemberIdentification2.yaml
+  LEI:
+    $ref: ./LEIIdentifier.yaml
+  Nm:
+    $ref: ./Max140Text.yaml
+  PstlAdr:
+    $ref: ./PostalAddress27.yaml
+  Othr:
+    $ref: ./GenericFinancialIdentification1.yaml
+example:
+  BICFI: BUKBGB22
+  Nm: Barclays Bank Plc
+  PstlAdr:
+    Ctry: GB
+    AdrLine:
+      - 1 Churchill Place
+      - London
+      - UK

package/fspiop/v2_0_ISO20022/openapi3/components/schemas/FxRequest_FICreditTransferProposal.yaml ADDED Viewed

@@ -0,0 +1,83 @@
+title: FxRequest_FICreditTransferProposal
+type: object
+properties:
+  GrpHdr:
+    $ref: ./GroupHeader113.yaml
+required:
+  - GrpHdr
+example:
+  GrpHdr:
+    MsgId: 123456789
+    CreDtTm: '2020-01-01T00:00:00Z'
+    NbOfTxs: 1
+    CtrlSum: 100.00
+    InitgPty:
+      Nm: Initiating Party Name
+      Id:
+        OrgId:
+          Othr:
+            - Id: 123456789
+              SchmeNm:
+                Cd: BIC
+    FwdgAgt:
+      FinInstnId:
+        BICFI: BICFID0
+    Dbtr:
+      Nm: Debtor Name
+      PstlAdr:
+        AdrLine:
+          - Debtor Address Line 1
+          - Debtor Address Line 2
+      Id:
+        OrgId:
+          Othr:
+            - Id: 123456789
+              SchmeNm:
+                Cd: BIC
+    DbtrAcct:
+      Id:
+        IBAN: BE71096123456769
+    DbtrAgt:
+      FinInstnId:
+        BICFI: BICFID0
+    Cdtr:
+      Nm: Creditor Name
+      PstlAdr:
+        AdrLine:
+          - Creditor Address Line 1
+          - Creditor Address Line 2
+      Id:
+        OrgId:
+          Othr:
+            - Id: 123456789
+              SchmeNm:
+                Cd: BIC
+    CdtrAcct:
+      Id:
+        IBAN: BE71096123456769
+    CdtrAgt:
+      FinInstnId:
+        BICFI: BICFID0
+    CdtTrfTxInf:
+      - PmtId:
+          InstrId: 123456789
+          EndToEndId: 123456789
+        Amt:
+          InstdAmt:
+            Ccy: EUR
+            Amt: 100.00
+        CdtrAgt:
+          FinInstnId:
+            BICFI: BICFID0
+        Cdtr:
+          Nm: Creditor Name
+          PstlAdr:
+            AdrLine:
+              - Creditor Address Line 1
+              - Creditor Address Line 2
+          Id:
+            OrgId:
+              Othr:
+                - Id: 123456789
+                  SchmeNm:
+                    Cd: BIC

package/fspiop/v2_0_ISO20022/openapi3/components/schemas/FxResponse_FICreditTransferConfirmation.yaml ADDED Viewed

@@ -0,0 +1,81 @@
+title: FxResponse_FICreditTransferConfirmation
+type: object
+properties:
+  GrpHdr:
+    $ref: ./GroupHeader113.yaml
+  CdtTrfTxInf:
+    $ref: ./CreditTransferTransaction68.yaml
+required:
+  - GrpHdr
+  - CdtTrfTxInf
+example:
+  GrpHdr:
+    MsgId: 20191122-123456
+    CreDtTm: '2019-11-22T12:34:56'
+    NbOfTxs: 1
+    CtrlSum: 100.00
+    InitgPty:
+      Nm: Initiating Party Name
+    MsgRcpt:
+      Nm: Message Recipient Name
+  CdtTrfTxInf:
+    PmtId:
+      InstrId: 20191122-123456
+      EndToEndId: 20191122-123456
+    PmtTpInf:
+      InstrPrty: NORM
+      CtgyPurp: SUPP
+    IntrBkSttlmAmt:
+      Amt: 100.00
+      Ccy: EUR
+    ChrgBr: SLEV
+    Cdtr:
+      Nm: Creditor Name
+    CdtrAcct:
+      Id:
+        IBAN: BE71096123456769
+      Tp:
+        Cd: CACC
+      Ccy: EUR
+      Nm: My account
+    CdtrAgt:
+      FinInstnId:
+        BICFI: BNBABEBB
+    CdtrAgtAcct:
+      Id:
+        IBAN: BE71096123456769
+      Tp:
+        Cd: CACC
+      Ccy: EUR
+      Nm: My account
+    Dbtr:
+      Nm: Debtor Name
+    DbtrAcct:
+      Id:
+        IBAN: BE71096123456769
+      Tp:
+        Cd: CACC
+      Ccy: EUR
+      Nm: My account
+    DbtrAgt:
+      FinInstnId:
+        BICFI: BNBABEBB
+    DbtrAgtAcct:
+      Id:
+        IBAN: BE71096123456769
+      Tp:
+        Cd: CACC
+      Ccy: EUR
+      Nm: My account
+    RmtInf:
+      Ustrd: Remittance Information
+    RgltryRptg:
+      Dbtr:
+        Nm: Debtor Name
+      DbtrAcct:
+        Id:
+          IBAN: BE71096123456769
+        Tp:
+          Cd: CACC
+        Ccy: EUR
+        Nm: My account

package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Fxecute_FinancialInstitutionCreditTransferV12.yaml ADDED Viewed

@@ -0,0 +1,57 @@
+title: Fxecute_FinancialInstitutionCreditTransferV12
+type: object
+properties:
+  GrpHdr:
+    $ref: ./GroupHeader129.yaml
+  CdtTrfTxInf:
+    $ref: ./CreditTransferTransaction68.yaml
+required:
+  - GrpHdr
+  - CdtTrfTxInf
+example:
+  GrpHdr:
+    MsgId: 20191113001
+    CreDtTm: 2019-11-13T10:00:00
+    NbOfTxs: 1
+    CtrlSum: 1000
+    InitgPty:
+      Nm: Initiating Party Name
+      Id:
+        OrgId:
+          Othr:
+            Id: 123456789
+            SchmeNm:
+              Cd: BBA
+    FwdgAgt:
+      FinInstnId:
+        BICFI: BBBBBBBB
+    DbtrAgt:
+      FinInstnId:
+        BICFI: AAAAAAAA
+    CdtrAgt:
+      FinInstnId:
+        BICFI: CCCCCCCC
+  CdtTrfTxInf:
+    PmtId:
+      InstrId: 20191113001
+      EndToEndId: 20191113001
+    PmtTpInf:
+      InstrPrty: NORM
+      CtgyPurp:
+        Cd: SUPP
+    InstrForCdtrAgt:
+      Cd: /ACC/123456789
+    IntrBkSttlmAmt:
+      Amt: 1000
+      Ccy: EUR
+    ChrgBr: SLEV
+    CdtrAgt:
+      FinInstnId:
+        BICFI: CCCCCCCC
+    Cdtr:
+      Nm: Creditor Name
+    CdtrAcct:
+      Id:
+        IBAN: BE71096123456769
+    RmtInf:
+      Ustrd: Payment for invoice 12345

package/fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericAccountIdentification1.yaml ADDED Viewed

@@ -0,0 +1,16 @@
+title: GenericAccountIdentification1
+type: object
+properties:
+  Id:
+    $ref: ./Max34Text.yaml
+  SchmeNm:
+    $ref: ./AccountSchemeName1Choice.yaml
+  Issr:
+    $ref: ./Max35Text.yaml
+required:
+  - Id
+example:
+  Id: 123
+  SchmeNm:
+    Cd: IBAN
+  Issr: BIC

package/fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericFinancialIdentification1.yaml ADDED Viewed

@@ -0,0 +1,16 @@
+title: GenericFinancialIdentification1
+type: object
+properties:
+  Id:
+    $ref: ./Max35Text.yaml
+  SchmeNm:
+    $ref: ./FinancialIdentificationSchemeName1Choice.yaml
+  Issr:
+    $ref: ./Max35Text.yaml
+required:
+  - Id
+example:
+  Id: 123
+  SchmeNm:
+    Cd: IBAN
+  Issr: BIC

package/fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericIdentification3.yaml ADDED Viewed

@@ -0,0 +1,12 @@
+title: GenericIdentification3
+type: object
+properties:
+  Id:
+    $ref: ./Max35Text.yaml
+  Issr:
+    $ref: ./Max35Text.yaml
+required:
+  - Id
+example:
+  Id: 123
+  Issr: BIC

package/fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericIdentification30.yaml ADDED Viewed

@@ -0,0 +1,16 @@
+title: GenericIdentification30
+type: object
+properties:
+  Id:
+    $ref: ./Exact4AlphaNumericText.yaml
+  Issr:
+    $ref: ./Max35Text.yaml
+  SchmeNm:
+    $ref: ./Max35Text.yaml
+required:
+  - Id
+  - Issr
+example:
+  Id: 1234
+  Issr: BIC
+  SchmeNm: BICFI

package/fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericOrganisationIdentification1.yaml ADDED Viewed

@@ -0,0 +1,16 @@
+title: GenericOrganisationIdentification1
+type: object
+properties:
+  Id:
+    $ref: ./Max35Text.yaml
+  SchmeNm:
+    $ref: ./OrganisationIdentificationSchemeName1Choice.yaml
+  Issr:
+    $ref: ./Max35Text.yaml
+required:
+  - Id
+example:
+  Id: 123
+  SchmeNm:
+    Cd: BIC
+  Issr: BIC

package/fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericOrganisationIdentification3.yaml ADDED Viewed

@@ -0,0 +1,16 @@
+title: GenericOrganisationIdentification3
+type: object
+properties:
+  Id:
+    $ref: ./Max256Text.yaml
+  SchmeNm:
+    $ref: ./OrganisationIdentificationSchemeName1Choice.yaml
+  Issr:
+    $ref: ./Max35Text.yaml
+required:
+  - Id
+example:
+  Id: 123
+  SchmeNm:
+    Cd: BIC
+  Issr: BIC

package/fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericPersonIdentification1.yaml ADDED Viewed

@@ -0,0 +1,16 @@
+title: GenericPersonIdentification1
+type: object
+properties:
+  Id:
+    $ref: ./Max35Text.yaml
+  SchmeNm:
+    $ref: ./PersonIdentificationSchemeName1Choice.yaml
+  Issr:
+    $ref: ./Max35Text.yaml
+required:
+  - Id
+example:
+  Id: 123
+  SchmeNm:
+    Cd: DRLC
+  Issr: BIC

package/fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericPersonIdentification2.yaml ADDED Viewed

@@ -0,0 +1,16 @@
+title: GenericPersonIdentification2
+type: object
+properties:
+  Id:
+    $ref: ./Max256Text.yaml
+  SchmeNm:
+    $ref: ./PersonIdentificationSchemeName1Choice.yaml
+  Issr:
+    $ref: ./Max35Text.yaml
+required:
+  - Id
+example:
+  Id: 123
+  SchmeNm:
+    Cd: DRLC
+  Issr: BIC