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

package/docs/fspiop-rest-v2.0-openapi3-snippets.yaml

@@ -2918,7 +2918,7 @@ components:
       title: CorrelationId
       type: string
       pattern: >-
-        ^[0-9a-f]{8}-[0-9a-f]{4}-[1-7][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
+        ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
       description: >-
         Identifier that correlates all messages of the same sequence. The API
         data type UUID (Universally Unique Identifier) is a JSON String in

package/docs/index.html

@@ -43,6 +43,7 @@
           {url: "fspiop-rest-v1.0-openapi3-snippets.yaml", name: "v1.0"},
           {url: "fspiop-rest-v1.1-openapi3-snippets.yaml", name: "v1.1"},
           {url: "fspiop-rest-v2.0-openapi3-snippets.yaml", name: "v2.0"},
+          {url: "fspiop-rest-v2.0-ISO20022-openapi3-snippets.yaml", name: "v2.0_ISO20022"},
           {url: "thirdparty-openapi3-snippets.yaml", name: "thirdparty"},
           {url: "sdk-scheme-adapter-backend-v2_0_0-openapi3-snippets.yaml", name: "SDK Backend v2.0.0"},
           {url: "sdk-scheme-adapter-outbound-v2_0_0-openapi3-snippets.yaml", name: "SDK Outbound v2.0.0"},

package/docs/sdk-scheme-adapter-backend-v2_0_0-openapi3-snippets.yaml

@@ -618,7 +618,7 @@ components:
       type: string
     bulkQuoteId:
       description: A Mojaloop API bulk quote identifier (UUID).
-      pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-7][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
+      pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
       type: string
     bulkQuoteRequest:
       description: A request for a bulk quote.
@@ -664,7 +664,7 @@ components:
       type: object
     bulkTransferId:
       description: A Mojaloop API transfer identifier (UUID).
-      pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-7][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
+      pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
       type: string
     bulkTransferRequest:
       properties:
@@ -1118,7 +1118,7 @@ components:
       type: string
     quoteId:
       description: A Mojaloop API quote identifier (UUID).
-      pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-7][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
+      pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
       type: string
     quoteRequest:
       description: A request for a quote for transfer from the DFSP backend.
@@ -1222,7 +1222,7 @@ components:
       type: string
     transactionId:
       description: ID of the transaction, the ID is decided by the Payer FSP during the creation of the quote.
-      pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-7][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
+      pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
       type: string
     transactionRequest:
       description: A request for a pull based transfer.
@@ -1268,7 +1268,7 @@ components:
       type: object
     transactionRequestId:
       description: A Mojaloop API transaction request identifier (UUID).
-      pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-7][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
+      pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
       type: string
     transactionRequestResponse:
       description: A response to a request for a quote.
@@ -1360,7 +1360,7 @@ components:
       type: object
     transferId:
       description: A Mojaloop API transfer identifier (UUID).
-      pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-7][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
+      pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
       type: string
     transferParty:
       properties:
@@ -1496,7 +1496,7 @@ components:
     CorrelationId:
       title: CorrelationId
       type: string
-      pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-7][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
+      pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
       description: Identifier that correlates all messages of the same sequence. The API data type UUID (Universally Unique Identifier) is a JSON String in canonical format, conforming to [RFC 4122](https://tools.ietf.org/html/rfc4122), that is restricted by a regular expression for interoperability reasons. A UUID is always 36 characters long, 32 hexadecimal symbols and 4 dashes (‘-‘).
       example: b51ec534-ee48-4575-b6a9-ead2955b8069
     bulkTransactionStatus:

package/docs/sdk-scheme-adapter-backend-v2_1_0-openapi3-snippets.yaml

@@ -674,7 +674,7 @@ components:
       type: string
     bulkQuoteId:
       description: A Mojaloop API bulk quote identifier (UUID).
-      pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-7][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
+      pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
       type: string
     bulkQuoteRequest:
       description: A request for a bulk quote.
@@ -720,7 +720,7 @@ components:
       type: object
     bulkTransferId:
       description: A Mojaloop API transfer identifier (UUID).
-      pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-7][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
+      pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
       type: string
     bulkTransferRequest:
       properties:
@@ -1163,7 +1163,7 @@ components:
       type: string
     quoteId:
       description: A Mojaloop API quote identifier (UUID).
-      pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-7][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
+      pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
       type: string
     quoteRequest:
       description: A request for a quote for transfer from the DFSP backend.
@@ -1275,7 +1275,7 @@ components:
       type: string
     transactionId:
       description: ID of the transaction, the ID is decided by the Payer FSP during the creation of the quote.
-      pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-7][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
+      pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
       type: string
     transactionRequest:
       description: A request for a pull based transfer.
@@ -1321,7 +1321,7 @@ components:
       type: object
     transactionRequestId:
       description: A Mojaloop API transaction request identifier (UUID).
-      pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-7][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
+      pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
       type: string
     transactionRequestResponse:
       description: A response to a request for a quote.
@@ -1413,7 +1413,7 @@ components:
       type: object
     transferId:
       description: A Mojaloop API transfer identifier (UUID).
-      pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-7][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
+      pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
       type: string
     transferParty:
       properties:
@@ -1603,7 +1603,7 @@ components:
     CorrelationId:
       title: CorrelationId
       type: string
-      pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-7][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
+      pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
       description: Identifier that correlates all messages of the same sequence. The API data type UUID (Universally Unique Identifier) is a JSON String in canonical format, conforming to [RFC 4122](https://tools.ietf.org/html/rfc4122), that is restricted by a regular expression for interoperability reasons. A UUID is always 36 characters long, 32 hexadecimal symbols and 4 dashes (‘-‘).
       example: b51ec534-ee48-4575-b6a9-ead2955b8069
     bulkTransactionStatus:

package/docs/sdk-scheme-adapter-outbound-v2_0_0-openapi3-snippets.yaml

@@ -680,7 +680,7 @@ components:
     CorrelationId:
       title: CorrelationId
       type: string
-      pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-7][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
+      pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
       description: Identifier that correlates all messages of the same sequence. The API data type UUID (Universally Unique Identifier) is a JSON String in canonical format, conforming to [RFC 4122](https://tools.ietf.org/html/rfc4122), that is restricted by a regular expression for interoperability reasons. A UUID is always 36 characters long, 32 hexadecimal symbols and 4 dashes (‘-‘).
       example: b51ec534-ee48-4575-b6a9-ead2955b8069
     errorResponse:

package/docs/sdk-scheme-adapter-outbound-v2_1_0-openapi3-snippets.yaml

@@ -762,7 +762,7 @@ components:
     CorrelationId:
       title: CorrelationId
       type: string
-      pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-7][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
+      pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
       description: Identifier that correlates all messages of the same sequence. The API data type UUID (Universally Unique Identifier) is a JSON String in canonical format, conforming to [RFC 4122](https://tools.ietf.org/html/rfc4122), that is restricted by a regular expression for interoperability reasons. A UUID is always 36 characters long, 32 hexadecimal symbols and 4 dashes (‘-‘).
       example: b51ec534-ee48-4575-b6a9-ead2955b8069
     errorResponse:

package/docs/thirdparty-openapi3-snippets.yaml

@@ -2419,7 +2419,7 @@ components:
     CorrelationId:
       title: CorrelationId
       type: string
-      pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-7][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
+      pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
       description: Identifier that correlates all messages of the same sequence. The API data type UUID (Universally Unique Identifier) is a JSON String in canonical format, conforming to [RFC 4122](https://tools.ietf.org/html/rfc4122), that is restricted by a regular expression for interoperability reasons. A UUID is always 36 characters long, 32 hexadecimal symbols and 4 dashes (‘-‘).
       example: b51ec534-ee48-4575-b6a9-ead2955b8069
     ParticipantsPostRequest:

package/fspiop/v1_0/openapi3/components/schemas/CorrelationId.yaml

@@ -1,6 +1,6 @@
 title: CorrelationId
 type: string
-pattern: '^[0-9a-f]{8}-[0-9a-f]{4}-[1-7][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$'
+pattern: '^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$'
 description: >-
   Identifier that correlates all messages of the same sequence. The API data
   type UUID (Universally Unique Identifier) is a JSON String in canonical

package/fspiop/v1_1/openapi3/components/schemas/CorrelationId.yaml

@@ -1,6 +1,6 @@
 title: CorrelationId
 type: string
-pattern: '^[0-9a-f]{8}-[0-9a-f]{4}-[1-7][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$'
+pattern: '^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$'
 description: >-
   Identifier that correlates all messages of the same sequence. The API data
   type UUID (Universally Unique Identifier) is a JSON String in canonical

package/fspiop/v2_0/openapi3/components/schemas/CorrelationId.yaml

@@ -1,6 +1,6 @@
 title: CorrelationId
 type: string
-pattern: '^[0-9a-f]{8}-[0-9a-f]{4}-[1-7][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$'
+pattern: '^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$'
 description: >-
   Identifier that correlates all messages of the same sequence. The API data
   type UUID (Universally Unique Identifier) is a JSON String in canonical

package/fspiop/v2_0_ISO20022/openapi3/components/headers/Content-Length.yaml

@@ -0,0 +1,9 @@
+required: false
+schema:
+  type: integer
+description: >-
+  The `Content-Length` header field indicates the anticipated size of the
+  payload body. Only sent if there is a body.
+
+
+  **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes).

package/fspiop/v2_0_ISO20022/openapi3/components/headers/Content-Type.yaml

@@ -0,0 +1,6 @@
+schema:
+  type: string
+required: true
+description: >-
+  The `Content-Type` header indicates the specific version of the API used to
+  send the payload body.

package/fspiop/v2_0_ISO20022/openapi3/components/parameters/Accept.yaml

@@ -0,0 +1,8 @@
+name: Accept
+in: header
+required: true
+schema:
+  type: string
+description: >-
+  The `Accept` header field indicates the version of the API the client would
+  like the server to use.

package/fspiop/v2_0_ISO20022/openapi3/components/parameters/Content-Length.yaml

@@ -0,0 +1,11 @@
+name: Content-Length
+in: header
+required: false
+schema:
+  type: integer
+description: >-
+  The `Content-Length` header field indicates the anticipated size of the
+  payload body. Only sent if there is a body.
+
+
+  **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes).

package/fspiop/v2_0_ISO20022/openapi3/components/parameters/Content-Type.yaml

@@ -0,0 +1,8 @@
+name: Content-Type
+in: header
+schema:
+  type: string
+required: true
+description: >-
+  The `Content-Type` header indicates the specific version of the API used to
+  send the payload body.

package/fspiop/v2_0_ISO20022/openapi3/components/parameters/Date.yaml

@@ -0,0 +1,6 @@
+name: Date
+in: header
+schema:
+  type: string
+required: true
+description: The `Date` header field indicates the date when the request was sent.

package/fspiop/v2_0_ISO20022/openapi3/components/parameters/FSPIOP-Destination.yaml

@@ -0,0 +1,13 @@
+name: FSPIOP-Destination
+in: header
+schema:
+  type: string
+required: false
+description: >-
+  The `FSPIOP-Destination` header field is a non-HTTP standard field used by the
+  API for HTTP header based routing of requests and responses to the
+  destination. The field must be set by the original sender of the request if
+  the destination is known (valid for all services except GET /parties) so that
+  any entities between the client and the server do not need to parse the
+  payload for routing purposes. If the destination is not known (valid for
+  service GET /parties), the field should be left empty.

package/fspiop/v2_0_ISO20022/openapi3/components/parameters/FSPIOP-Encryption.yaml

@@ -0,0 +1,8 @@
+name: FSPIOP-Encryption
+in: header
+schema:
+  type: string
+required: false
+description: >-
+  The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the
+  API for applying end-to-end encryption of the request.

package/fspiop/v2_0_ISO20022/openapi3/components/parameters/FSPIOP-HTTP-Method.yaml

@@ -0,0 +1,11 @@
+name: FSPIOP-HTTP-Method
+in: header
+schema:
+  type: string
+required: false
+description: >-
+  The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the
+  API for signature verification, should contain the service HTTP method.
+  Required if signature verification is used, for more information, see [the API
+  Signature
+  document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set).

package/fspiop/v2_0_ISO20022/openapi3/components/parameters/FSPIOP-Signature.yaml

@@ -0,0 +1,8 @@
+name: FSPIOP-Signature
+in: header
+schema:
+  type: string
+required: false
+description: >-
+  The `FSPIOP-Signature` header field is a non-HTTP standard field used by the
+  API for applying an end-to-end request signature.

package/fspiop/v2_0_ISO20022/openapi3/components/parameters/FSPIOP-Source.yaml

@@ -0,0 +1,10 @@
+name: FSPIOP-Source
+in: header
+schema:
+  type: string
+required: true
+description: >-
+  The `FSPIOP-Source` header field is a non-HTTP standard field used by the API
+  for identifying the sender of the HTTP request. The field should be set by the
+  original sender of the request. Required for routing and signature
+  verification (see header field `FSPIOP-Signature`).

package/fspiop/v2_0_ISO20022/openapi3/components/parameters/FSPIOP-URI.yaml

@@ -0,0 +1,10 @@
+name: FSPIOP-URI
+in: header
+schema:
+  type: string
+required: false
+description: >-
+  The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for
+  signature verification, should contain the service URI. Required if signature
+  verification is used, for more information, see [the API Signature
+  document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set).

package/fspiop/v2_0_ISO20022/openapi3/components/parameters/ID.yaml

@@ -0,0 +1,6 @@
+name: ID
+in: path
+required: true
+schema:
+  type: string
+description: The identifier value.

package/fspiop/v2_0_ISO20022/openapi3/components/parameters/SubId.yaml

@@ -0,0 +1,8 @@
+name: SubId
+in: path
+required: true
+schema:
+  type: string
+description: >-
+  A sub-identifier of the party identifier, or a sub-type of the party
+  identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`.

package/fspiop/v2_0_ISO20022/openapi3/components/parameters/Type.yaml

@@ -0,0 +1,6 @@
+name: Type
+in: path
+required: true
+schema:
+  type: string
+description: The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`.

package/fspiop/v2_0_ISO20022/openapi3/components/parameters/X-Forwarded-For.yaml

@@ -0,0 +1,15 @@
+name: X-Forwarded-For
+in: header
+schema:
+  type: string
+required: false
+description: >-
+  The `X-Forwarded-For` header field is an unofficially accepted standard used
+  for informational purposes of the originating client IP address, as a request
+  might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For`
+  values should be expected and supported by implementers of the API.
+
+
+  **Note:** An alternative to `X-Forwarded-For` is defined in [RFC
+  7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is
+  less-used and supported than `X-Forwarded-For`.

package/fspiop/v2_0_ISO20022/openapi3/components/responses/200.yaml

@@ -0,0 +1 @@
+description: OK

package/fspiop/v2_0_ISO20022/openapi3/components/responses/202.yaml

@@ -0,0 +1 @@
+description: Accepted

package/fspiop/v2_0_ISO20022/openapi3/components/responses/400.yaml

@@ -0,0 +1,10 @@
+description: Bad Request
+content:
+  application/json:
+    schema:
+      $ref: ../schemas/ErrorInformationResponse.yaml
+headers:
+  Content-Length:
+    $ref: ../headers/Content-Length.yaml
+  Content-Type:
+    $ref: ../headers/Content-Type.yaml

package/fspiop/v2_0_ISO20022/openapi3/components/responses/401.yaml

@@ -0,0 +1,10 @@
+description: Unauthorized
+content:
+  application/json:
+    schema:
+      $ref: ../schemas/ErrorInformationResponse.yaml
+headers:
+  Content-Length:
+    $ref: ../headers/Content-Length.yaml
+  Content-Type:
+    $ref: ../headers/Content-Type.yaml

package/fspiop/v2_0_ISO20022/openapi3/components/responses/403.yaml

@@ -0,0 +1,10 @@
+description: Forbidden
+content:
+  application/json:
+    schema:
+      $ref: ../schemas/ErrorInformationResponse.yaml
+headers:
+  Content-Length:
+    $ref: ../headers/Content-Length.yaml
+  Content-Type:
+    $ref: ../headers/Content-Type.yaml

package/fspiop/v2_0_ISO20022/openapi3/components/responses/404.yaml

@@ -0,0 +1,10 @@
+description: Not Found
+content:
+  application/json:
+    schema:
+      $ref: ../schemas/ErrorInformationResponse.yaml
+headers:
+  Content-Length:
+    $ref: ../headers/Content-Length.yaml
+  Content-Type:
+    $ref: ../headers/Content-Type.yaml

package/fspiop/v2_0_ISO20022/openapi3/components/responses/405.yaml

@@ -0,0 +1,10 @@
+description: Method Not Allowed
+content:
+  application/json:
+    schema:
+      $ref: ../schemas/ErrorInformationResponse.yaml
+headers:
+  Content-Length:
+    $ref: ../headers/Content-Length.yaml
+  Content-Type:
+    $ref: ../headers/Content-Type.yaml

package/fspiop/v2_0_ISO20022/openapi3/components/responses/406.yaml

@@ -0,0 +1,10 @@
+description: Not Acceptable
+content:
+  application/json:
+    schema:
+      $ref: ../schemas/ErrorInformationResponse.yaml
+headers:
+  Content-Length:
+    $ref: ../headers/Content-Length.yaml
+  Content-Type:
+    $ref: ../headers/Content-Type.yaml

package/fspiop/v2_0_ISO20022/openapi3/components/responses/501.yaml

@@ -0,0 +1,10 @@
+description: Not Implemented
+content:
+  application/json:
+    schema:
+      $ref: ../schemas/ErrorInformationResponse.yaml
+headers:
+  Content-Length:
+    $ref: ../headers/Content-Length.yaml
+  Content-Type:
+    $ref: ../headers/Content-Type.yaml

package/fspiop/v2_0_ISO20022/openapi3/components/responses/503.yaml

@@ -0,0 +1,10 @@
+description: Service Unavailable
+content:
+  application/json:
+    schema:
+      $ref: ../schemas/ErrorInformationResponse.yaml
+headers:
+  Content-Length:
+    $ref: ../headers/Content-Length.yaml
+  Content-Type:
+    $ref: ../headers/Content-Type.yaml

package/fspiop/v2_0_ISO20022/openapi3/components/schemas/AccountIdentification4Choice.yaml

@@ -0,0 +1,17 @@
+title: AccountIdentification4Choice
+type: object
+description: >
+  Specifies the unique identification of an account as assigned by the account
+  servicer.
+properties:
+  IBAN:
+    $ref: ./IBAN2007Identifier.yaml
+  Othr:
+    $ref: ./GenericAccountIdentification1.yaml
+oneOf:
+  - required:
+      - IBAN
+  - required:
+      - Othr
+example:
+  IBAN: BE71096123456769

package/fspiop/v2_0_ISO20022/openapi3/components/schemas/AccountSchemeName1Choice.yaml

@@ -0,0 +1,16 @@
+title: AccountSchemeName1Choice
+type: object
+description: |
+  Sets of elements to identify a name of the identification scheme.
+properties:
+  Cd:
+    $ref: ./ExternalAccountIdentification1Code.yaml
+  Prtry:
+    $ref: ./Max35Text.yaml
+oneOf:
+  - required:
+      - Cd
+  - required:
+      - Prtry
+example:
+  Cd: 1111

package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ActiveCurrencyAndAmount.yaml

@@ -0,0 +1,16 @@
+title: ActiveCurrencyAndAmount
+type: object
+description: >
+  A number of monetary units specified in an active currency where the
+  unit of currency is explicit and compliant with ISO 4217.
+properties:
+  ActiveCurrencyAndAmount:
+    $ref: ./ActiveCurrencyAndAmount_SimpleType.yaml
+  Ccy:
+    $ref: ./ActiveCurrencyCode.yaml
+required:
+  - ActiveCurrencyAndAmount
+  - Ccy
+example:
+  ActiveCurrencyAndAmount: 123.45
+  Ccy: USD

package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ActiveCurrencyAndAmount_SimpleType.yaml

@@ -0,0 +1,13 @@
+title: ActiveCurrencyAndAmount_SimpleType
+type: string
+description: |
+  NOTE: This regex doesn't seem correct given it's xsd definition.
+  <xs:simpleType name="ActiveCurrencyAndAmount_SimpleType">
+    <xs:restriction base="xs:decimal">
+      <xs:fractionDigits value="5"/>
+      <xs:totalDigits value="18"/>
+      <xs:minInclusive value="0"/>
+    </xs:restriction>
+  </xs:simpleType>
+pattern: ^(?=[\d\-\.\,]{1,18}$)([\d\-\,\.]{1,5})?$
+example: 123.45

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

@@ -0,0 +1,8 @@
+title: ActiveCurrencyCode
+type: string
+pattern: ^[A-Z]{3,3}$
+description: >-
+  A code allocated to a currency by a Maintenance Agency under an international
+  identification scheme as described in the latest edition of the international standard ISO
+  4217 "Codes for the representation of currencies and funds".
+example: USD

package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ActiveOrHistoricCurrencyAndAmount.yaml

@@ -0,0 +1,16 @@
+title: ActiveOrHistoricCurrencyAndAmount
+type: object
+description: >
+  A number of monetary units specified in an active or a historic currency where
+  the unit of currency is explicit and compliant with ISO 4217.
+properties:
+  ActiveOrHistoricCurrencyAndAmount:
+    $ref: ./ActiveOrHistoricCurrencyAndAmount_SimpleType.yaml
+  Ccy:
+    $ref: ./ActiveOrHistoricCurrencyCode.yaml
+required:
+  - ActiveOrHistoricCurrencyAndAmount
+  - Ccy
+example:
+  ActiveOrHistoricCurrencyAndAmount: 123.45
+  Ccy: USD

package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ActiveOrHistoricCurrencyAndAmount_SimpleType.yaml

@@ -0,0 +1,4 @@
+title: ActiveOrHistoricCurrencyAndAmount_SimpleType
+type: string
+pattern: ^(?=[\d\-\.\,]{1,18}$)([\d\-\,\.]{1,5})?$
+example: 123.45

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

@@ -0,0 +1,8 @@
+title: ActiveOrHistoricCurrencyCode
+type: string
+description: >
+  A code allocated to a currency by a Maintenance Agency under an international
+  identification scheme, as described in the latest edition of the international standard ISO
+  4217 "Codes for the representation of currencies and funds".
+pattern: ^[A-Z]{3,3}$
+example: USD

package/fspiop/v2_0_ISO20022/openapi3/components/schemas/AddressType2Code.yaml

@@ -0,0 +1,12 @@
+description: |
+  AddressType2Code
+  Specifies the type of address.
+enum:
+  - ADDR
+  - PBOX
+  - HOME
+  - BIZZ
+  - MLTO
+  - DLVY
+type: string
+example: ADDR

package/fspiop/v2_0_ISO20022/openapi3/components/schemas/AddressType3Choice.yaml

@@ -0,0 +1,16 @@
+title: AddressType3Choice
+type: object
+description: |
+  Choice of formats for the type of address.
+properties:
+  Cd:
+    $ref: ./AddressType2Code.yaml
+  Prtry:
+    $ref: ./GenericIdentification30.yaml
+oneOf:
+  - required:
+      - Cd
+  - required:
+      - Prtry
+example:
+  Cd: ADDR

package/fspiop/v2_0_ISO20022/openapi3/components/schemas/AnyBICDec2014Identifier.yaml

@@ -0,0 +1,12 @@
+title: AnyBICDec2014Identifier
+type: string
+description: >
+  AnyBICDec2014Identifier
+
+  Code allocated to a financial or non-financial institution by the
+
+  ISO 9362 Registration Authority, as described in ISO 9362: 2014
+
+  - "Banking - Banking telecommunication messages - Business identifier code (BIC)".
+pattern: ^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$
+example: J5BMVH7D

package/fspiop/v2_0_ISO20022/openapi3/components/schemas/BICFIDec2014Identifier.yaml

@@ -0,0 +1,10 @@
+title: BICFIDec2014Identifier
+type: string
+description: |
+  Code allocated to a financial institution by the ISO 9362 Registration
+
+  Authority as described in ISO 9362: 2014
+
+  - "Banking - Banking telecommunication messages - Business identifier code (BIC)".
+pattern: ^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$
+example: J5BMVH7D