npm - @mojaloop/api-snippets - Versions diffs - 17.7.2 → 17.7.3 - Mend

@mojaloop/api-snippets 17.7.2 → 17.7.3

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

package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ActiveCurrencyCode.yaml CHANGED Viewed

@@ -1,8 +1,176 @@
 title: ActiveCurrencyCode
 type: string
-pattern: ^[A-Z]{3,3}$
 description: >-
   A code allocated to a currency by a Maintenance Agency under an international
   identification scheme as described in the latest edition of the international standard ISO
   4217 "Codes for the representation of currencies and funds".
+  NOTE: This has been modified away from the original ISO20022 pattern to enums.
 example: USD
+minLength: 3
+maxLength: 3
+enum:
+  - AED
+  - AFN
+  - ALL
+  - AMD
+  - ANG
+  - AOA
+  - ARS
+  - AUD
+  - AWG
+  - AZN
+  - BAM
+  - BBD
+  - BDT
+  - BGN
+  - BHD
+  - BIF
+  - BMD
+  - BND
+  - BOB
+  - BRL
+  - BSD
+  - BTN
+  - BWP
+  - BYN
+  - BZD
+  - CAD
+  - CDF
+  - CHF
+  - CLP
+  - CNY
+  - COP
+  - CRC
+  - CUC
+  - CUP
+  - CVE
+  - CZK
+  - DJF
+  - DKK
+  - DOP
+  - DZD
+  - EGP
+  - ERN
+  - ETB
+  - EUR
+  - FJD
+  - FKP
+  - GBP
+  - GEL
+  - GGP
+  - GHS
+  - GIP
+  - GMD
+  - GNF
+  - GTQ
+  - GYD
+  - HKD
+  - HNL
+  - HRK
+  - HTG
+  - HUF
+  - IDR
+  - ILS
+  - IMP
+  - INR
+  - IQD
+  - IRR
+  - ISK
+  - JEP
+  - JMD
+  - JOD
+  - JPY
+  - KES
+  - KGS
+  - KHR
+  - KMF
+  - KPW
+  - KRW
+  - KWD
+  - KYD
+  - KZT
+  - LAK
+  - LBP
+  - LKR
+  - LRD
+  - LSL
+  - LYD
+  - MAD
+  - MDL
+  - MGA
+  - MKD
+  - MMK
+  - MNT
+  - MOP
+  - MRO
+  - MUR
+  - MVR
+  - MWK
+  - MXN
+  - MYR
+  - MZN
+  - NAD
+  - NGN
+  - NIO
+  - NOK
+  - NPR
+  - NZD
+  - OMR
+  - PAB
+  - PEN
+  - PGK
+  - PHP
+  - PKR
+  - PLN
+  - PYG
+  - QAR
+  - RON
+  - RSD
+  - RUB
+  - RWF
+  - SAR
+  - SBD
+  - SCR
+  - SDG
+  - SEK
+  - SGD
+  - SHP
+  - SLL
+  - SOS
+  - SPL
+  - SRD
+  - STD
+  - SVC
+  - SYP
+  - SZL
+  - THB
+  - TJS
+  - TMT
+  - TND
+  - TOP
+  - TRY
+  - TTD
+  - TVD
+  - TWD
+  - TZS
+  - UAH
+  - UGX
+  - USD
+  - UYU
+  - UZS
+  - VEF
+  - VND
+  - VUV
+  - WST
+  - XAF
+  - XCD
+  - XDR
+  - XOF
+  - XPF
+  - XTS
+  - XXX
+  - YER
+  - ZAR
+  - ZMW
+  - ZWD

package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ActiveOrHistoricCurrencyCode.yaml CHANGED Viewed

@@ -4,5 +4,173 @@ description: >
   A code allocated to a currency by a Maintenance Agency under an international
   identification scheme, as described in the latest edition of the international standard ISO
   4217 "Codes for the representation of currencies and funds".
-pattern: ^[A-Z]{3,3}$
+  NOTE: This has been modified away from the original ISO20022 pattern to enums.
 example: USD
+minLength: 3
+maxLength: 3
+enum:
+  - AED
+  - AFN
+  - ALL
+  - AMD
+  - ANG
+  - AOA
+  - ARS
+  - AUD
+  - AWG
+  - AZN
+  - BAM
+  - BBD
+  - BDT
+  - BGN
+  - BHD
+  - BIF
+  - BMD
+  - BND
+  - BOB
+  - BRL
+  - BSD
+  - BTN
+  - BWP
+  - BYN
+  - BZD
+  - CAD
+  - CDF
+  - CHF
+  - CLP
+  - CNY
+  - COP
+  - CRC
+  - CUC
+  - CUP
+  - CVE
+  - CZK
+  - DJF
+  - DKK
+  - DOP
+  - DZD
+  - EGP
+  - ERN
+  - ETB
+  - EUR
+  - FJD
+  - FKP
+  - GBP
+  - GEL
+  - GGP
+  - GHS
+  - GIP
+  - GMD
+  - GNF
+  - GTQ
+  - GYD
+  - HKD
+  - HNL
+  - HRK
+  - HTG
+  - HUF
+  - IDR
+  - ILS
+  - IMP
+  - INR
+  - IQD
+  - IRR
+  - ISK
+  - JEP
+  - JMD
+  - JOD
+  - JPY
+  - KES
+  - KGS
+  - KHR
+  - KMF
+  - KPW
+  - KRW
+  - KWD
+  - KYD
+  - KZT
+  - LAK
+  - LBP
+  - LKR
+  - LRD
+  - LSL
+  - LYD
+  - MAD
+  - MDL
+  - MGA
+  - MKD
+  - MMK
+  - MNT
+  - MOP
+  - MRO
+  - MUR
+  - MVR
+  - MWK
+  - MXN
+  - MYR
+  - MZN
+  - NAD
+  - NGN
+  - NIO
+  - NOK
+  - NPR
+  - NZD
+  - OMR
+  - PAB
+  - PEN
+  - PGK
+  - PHP
+  - PKR
+  - PLN
+  - PYG
+  - QAR
+  - RON
+  - RSD
+  - RUB
+  - RWF
+  - SAR
+  - SBD
+  - SCR
+  - SDG
+  - SEK
+  - SGD
+  - SHP
+  - SLL
+  - SOS
+  - SPL
+  - SRD
+  - STD
+  - SVC
+  - SYP
+  - SZL
+  - THB
+  - TJS
+  - TMT
+  - TND
+  - TOP
+  - TRY
+  - TTD
+  - TVD
+  - TWD
+  - TZS
+  - UAH
+  - UGX
+  - USD
+  - UYU
+  - UZS
+  - VEF
+  - VND
+  - VUV
+  - WST
+  - XAF
+  - XCD
+  - XDR
+  - XOF
+  - XPF
+  - XTS
+  - XXX
+  - YER
+  - ZAR
+  - ZMW
+  - ZWD

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

@@ -0,0 +1,9 @@
+title: AmountTypeEnum
+description: |
+  NOTE: This pattern is not the original ISO20022 specification.
+        This represents the enum values when mapping to and from FSPIOP specification.
+type: string
+enum:
+  - SEND
+  - RECEIVE
+example: SEND

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

@@ -0,0 +1,136 @@
+title: CreditTransferTransaction68_Put_FX_Quotes_ID
+description: >
+  Provides further details specific to the individual transaction(s) included in
+  the message.
+type: object
+properties:
+  PmtId:
+    allOf:
+      - $ref: ./PaymentIdentification13.yaml
+      - description: >
+          PaymentIdentification
+          Set of elements used to reference a payment instruction.
+  PmtTpInf:
+    allOf:
+      - $ref: ./PaymentTypeInformation28.yaml
+      - description: >
+          PaymentTypeInformation
+          Set of elements used to further specify the type of transaction.
+  UndrlygCstmrCdtTrf:
+    allOf:
+      - $ref: ./UnderlyingCustomerCreditTransfer.yaml
+      - description: >
+          Underlying Customer Credit Transfer
+          TBD
+  IntrBkSttlmAmt:
+    allOf:
+      - $ref: ./ActiveCurrencyAndAmount.yaml
+      - description: >
+          InterbankSettlementAmount
+          Amount of money moved between the instructing agent and the instructed agent.
+  Dbtr:
+    allOf:
+      - $ref: ./BranchAndFinancialInstitutionIdentification8.yaml
+      - description: >
+          Debtor
+          Party that owes an amount of money to the (ultimate) creditor.
+  DbtrAcct:
+    allOf:
+      - $ref: ./CashAccount40.yaml
+      - description: >
+          DebtorAccount
+          Account used to process a payment.
+  DbtrAgt:
+    allOf:
+      - $ref: ./BranchAndFinancialInstitutionIdentification8.yaml
+      - description: >
+          DebtorAgent
+          Financial institution servicing an account for the debtor.
+  CdtrAgt:
+    allOf:
+      - $ref: ./BranchAndFinancialInstitutionIdentification8.yaml
+      - description: >
+          CreditorAgent
+          Financial institution servicing an account for the creditor.
+  Cdtr:
+    allOf:
+      - $ref: ./BranchAndFinancialInstitutionIdentification8.yaml
+      - description: >
+          Creditor
+          Party to which an amount of money is due.
+  CdtrAcct:
+    allOf:
+      - $ref: ./CashAccount40.yaml
+      - description: >
+          CreditorAccount
+          Account to which a credit entry is made.
+  InstrForCdtrAgt:
+    allOf:
+      - $ref: ./InstructionForCreditorAgent3_Put_FX_Quotes_ID.yaml
+      - description: >
+          InstructionForCreditorAgent
+          Set of elements used to provide information on the remittance advice.
+  Purp:
+    allOf:
+      - $ref: ./Purpose2Choice.yaml
+      - description: >
+          Purpose
+          Underlying reason for the payment transaction.
+  VrfctnOfTerms:
+    allOf:
+      - $ref: ./CryptographicLockChoice.yaml
+      - description: >
+          VerificationOfTerms
+          Set of elements used to provide information on the underlying terms of the transaction.
+required:
+  - PmtId
+  - IntrBkSttlmAmt
+  - Dbtr
+  - Cdtr
+example:
+  PmtId:
+    InstrId: INSTRID
+    EndToEndId: ENDTOENDID
+  PmtTpInf:
+    LclInstrm:
+      Cd: CHQB
+      Prtry: PROPRIETARY
+  IntrBkSttlmAmt:
+    Amount: 123.45
+    Ccy: EUR
+  Dbtr:
+    Nm: Debtor Name
+  DbtrAcct:
+    Id:
+      IBAN: IBAN
+  DbtrAgt:
+    FinInstnId:
+      BICFI: BICFI
+  CdtrAgt:
+    FinInstnId:
+      BICFI: BICFI
+  Cdtr:
+    Nm: Creditor Name
+  CdtrAcct:
+    Id:
+      IBAN: IBAN
+  InstrForCdtrAgt:
+    Cd: INSTRUCTION
+  Purp:
+    Cd: CHAR
+  VrfctnOfTerms:
+    Cntt: CONTENT
+    CnttTp: PROPRIETARY

package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Exact32HexBinaryText.yaml CHANGED Viewed

@@ -1,5 +1,8 @@
 title: Exact32HexBinaryText
 description: |
-  Specifies a hexadecimal string with a length of 32 characters.
+  Specifies a hexadecimal string.
+  NOTE: This pattern is not the original ISO20022 specification.
 type: string
-example: 1234567890ABCDEF1234567890ABCDEF
+pattern: '^[A-Za-z0-9-_]{43}$'
+maxLength: 48

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

@@ -9,7 +9,14 @@ description: |
     "RECV": "RECEIVED",
     "ABOR": "ABORTED"
   }
+  NOTE: enum enforcement is not apart of the ISO20022 specification, but is added here for FSPIOP mappings.
 type: string
 minLength: 1
 maxLength: 4
 example: COMM
+enum:
+  - COMM
+  - RESV
+  - RECV
+  - ABOR

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

@@ -14,9 +14,9 @@ properties:
           Set of characteristics shared by all individual transactions included in the message.
   CdtTrfTxInf:
     allOf:
-      - $ref: ./CreditTransferTransaction68.yaml
+      - $ref: ./CreditTransferTransaction68_Put_FX_Quotes_ID.yaml
       - description: >
-          CreditTransferTransactionInformation
+          CreditTransferTransaction68_Put_FX_Quotes_ID
           Set of elements providing information specific to the individual credit transfer(s).
 required:

package/fspiop/v2_0_ISO20022/openapi3/components/schemas/InstructionForCreditorAgent3.yaml CHANGED Viewed

@@ -22,4 +22,4 @@ properties:
           that is bilaterally agreed or specific to a user community.
 example:
   Cd: PHOA
-  InstrInf: Please advise/contact next agent by phone.
+  InstrInf: Please advise/contact next agent by phone.

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

@@ -0,0 +1,25 @@
+title: InstructionForCreditorAgent3_Put_FX_Quotes_ID
+description: >
+  Further information related to the processing of the payment instruction,
+  provided by the initiating party, and intended for the creditor agent.
+type: object
+properties:
+  Cd:
+    allOf:
+      - $ref: ./ExternalCreditorAgentInstruction1Code.yaml
+      - description: >
+          Code
+          Coded information related to the processing of the payment instruction, provided by the
+          initiating party, and intended for the creditor's agent.
+  InstrInf:
+    allOf:
+      - $ref: ./AmountTypeEnum.yaml
+      - description: >
+          InstructionInformation
+          Further information complementing the coded instruction or instruction to the creditor's agent
+          that is bilaterally agreed or specific to a user community.
+example:
+  Cd: PHOA
+  InstrInf: Please advise/contact next agent by phone.

package/fspiop/v2_0_ISO20022/openapi3/components/schemas/PaymentIdentification13.yaml CHANGED Viewed

@@ -5,7 +5,7 @@ type: object
 properties:
   InstrId:
     allOf:
-      - $ref: ./Max35Text.yaml
+      - $ref: ./ULIDIdentifier.yaml
       - description: |
           InstructionIdentification (FSPIOP equivalent: transactionRequestId)
@@ -15,9 +15,11 @@ properties:
           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.
+          This field has been changed from the original ISO20022 `Max35Text`` schema to a ULIDIdentifier schema.
   EndToEndId:
     allOf:
-      - $ref: ./Max35Text.yaml
+      - $ref: ./ULIDIdentifier.yaml
       - description: |
           EndToEndIdentification (FSPIOP equivalent: transactionId)
@@ -29,9 +31,11 @@ properties:
           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.
+          This field has been changed from the original ISO20022 `Max35Text`` schema to a ULIDIdentifier schema.
   TxId:
     allOf:
-      - $ref: ./Max35Text.yaml
+      - $ref: ./ULIDIdentifier.yaml
       - description: |
           TransactionIdentification (FSPIOP equivalent: quoteId in quote request, transferId in transfer request)
@@ -42,6 +46,8 @@ properties:
           the transaction on the interbank level.
           Usage: The instructing agent has to make sure that the transaction identification is unique for a preagreed period.
+          This field has been changed from the original ISO20022 `Max35Text`` schema to a ULIDIdentifier schema.
   UETR:
     allOf:
       - $ref: ./UUIDv4Identifier.yaml

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

@@ -0,0 +1,4 @@
+title: ULIDIdentifier
+type: string
+pattern: ^[0-9A-HJKMNP-TV-Z]{26}$
+example: 01AN4Z07BY79KA1307SR9X4MV3