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

package/fspiop/v2_0_ISO20022/openapi3/paths/quotes_{ID}.yaml

@@ -0,0 +1,80 @@
+parameters:
+  - $ref: ../components/parameters/ID.yaml
+  - $ref: ../components/parameters/Content-Type.yaml
+  - $ref: ../components/parameters/Date.yaml
+  - $ref: ../components/parameters/X-Forwarded-For.yaml
+  - $ref: ../components/parameters/FSPIOP-Source.yaml
+  - $ref: ../components/parameters/FSPIOP-Destination.yaml
+  - $ref: ../components/parameters/FSPIOP-Encryption.yaml
+  - $ref: ../components/parameters/FSPIOP-Signature.yaml
+  - $ref: ../components/parameters/FSPIOP-URI.yaml
+  - $ref: ../components/parameters/FSPIOP-HTTP-Method.yaml
+get:
+  description: >-
+    The HTTP request `GET /quotes/{ID}` is used to get information regarding a
+    quote created or requested earlier. The `{ID}` in the URI should contain the
+    `quoteId` that was used for the creation of the quote.
+  summary: Retrieve quote information
+  tags:
+    - quotes
+  operationId: QuotesByID
+  parameters:
+    - $ref: ../components/parameters/Accept.yaml
+  responses:
+    '202':
+      $ref: ../components/responses/202.yaml
+    '400':
+      $ref: ../components/responses/400.yaml
+    '401':
+      $ref: ../components/responses/401.yaml
+    '403':
+      $ref: ../components/responses/403.yaml
+    '404':
+      $ref: ../components/responses/404.yaml
+    '405':
+      $ref: ../components/responses/405.yaml
+    '406':
+      $ref: ../components/responses/406.yaml
+    '501':
+      $ref: ../components/responses/501.yaml
+    '503':
+      $ref: ../components/responses/503.yaml
+put:
+  description: >-
+    The callback `PUT /quotes/{ID}` is used to inform the client of a requested
+    or created quote. The `{ID}` in the URI should contain the `quoteId` that
+    was used for the creation of the quote, or the `{ID}` that was used in the
+    `GET /quotes/{ID}` request.
+  summary: Return quote information
+  tags:
+    - quotes
+  operationId: QuotesByID1
+  parameters:
+    - $ref: ../components/parameters/Content-Length.yaml
+  requestBody:
+    description: Quote information returned.
+    required: true
+    content:
+      application/json:
+        schema:
+          $ref: >-
+            ../components/schemas/TermsResponse_FIToFICustomerCreditConfirmation.yaml
+  responses:
+    '200':
+      $ref: ../components/responses/200.yaml
+    '400':
+      $ref: ../components/responses/400.yaml
+    '401':
+      $ref: ../components/responses/401.yaml
+    '403':
+      $ref: ../components/responses/403.yaml
+    '404':
+      $ref: ../components/responses/404.yaml
+    '405':
+      $ref: ../components/responses/405.yaml
+    '406':
+      $ref: ../components/responses/406.yaml
+    '501':
+      $ref: ../components/responses/501.yaml
+    '503':
+      $ref: ../components/responses/503.yaml

package/fspiop/v2_0_ISO20022/openapi3/paths/quotes_{ID}_error.yaml

@@ -0,0 +1,49 @@
+put:
+  description: >-
+    If the server is unable to find or create a quote, or some other processing
+    error occurs, the error callback `PUT /quotes/{ID}/error` is used. The
+    `{ID}` in the URI should contain the `quoteId` that was used for the
+    creation of the quote, or the `{ID}` that was used in the `GET /quotes/{ID}`
+    request.
+  summary: Return quote information error
+  tags:
+    - quotes
+  operationId: QuotesByIDAndError
+  parameters:
+    - $ref: ../components/parameters/ID.yaml
+    - $ref: ../components/parameters/Content-Length.yaml
+    - $ref: ../components/parameters/Content-Type.yaml
+    - $ref: ../components/parameters/Date.yaml
+    - $ref: ../components/parameters/X-Forwarded-For.yaml
+    - $ref: ../components/parameters/FSPIOP-Source.yaml
+    - $ref: ../components/parameters/FSPIOP-Destination.yaml
+    - $ref: ../components/parameters/FSPIOP-Encryption.yaml
+    - $ref: ../components/parameters/FSPIOP-Signature.yaml
+    - $ref: ../components/parameters/FSPIOP-URI.yaml
+    - $ref: ../components/parameters/FSPIOP-HTTP-Method.yaml
+  requestBody:
+    description: Details of the error returned.
+    required: true
+    content:
+      application/json:
+        schema:
+          $ref: ../components/schemas/PacsError_FIToFIPaymentStatusReportV15.yaml
+  responses:
+    '200':
+      $ref: ../components/responses/200.yaml
+    '400':
+      $ref: ../components/responses/400.yaml
+    '401':
+      $ref: ../components/responses/401.yaml
+    '403':
+      $ref: ../components/responses/403.yaml
+    '404':
+      $ref: ../components/responses/404.yaml
+    '405':
+      $ref: ../components/responses/405.yaml
+    '406':
+      $ref: ../components/responses/406.yaml
+    '501':
+      $ref: ../components/responses/501.yaml
+    '503':
+      $ref: ../components/responses/503.yaml

package/fspiop/v2_0_ISO20022/openapi3/paths/transfers.yaml

@@ -0,0 +1,46 @@
+post:
+  description: >-
+    The HTTP request `POST /transfers` is used to request the creation of a
+    transfer for the next ledger, and a financial transaction for the Payee FSP.
+  summary: Perform transfer
+  tags:
+    - transfers
+  operationId: transfers
+  parameters:
+    - $ref: ../components/parameters/Accept.yaml
+    - $ref: ../components/parameters/Content-Length.yaml
+    - $ref: ../components/parameters/Content-Type.yaml
+    - $ref: ../components/parameters/Date.yaml
+    - $ref: ../components/parameters/X-Forwarded-For.yaml
+    - $ref: ../components/parameters/FSPIOP-Source.yaml
+    - $ref: ../components/parameters/FSPIOP-Destination.yaml
+    - $ref: ../components/parameters/FSPIOP-Encryption.yaml
+    - $ref: ../components/parameters/FSPIOP-Signature.yaml
+    - $ref: ../components/parameters/FSPIOP-URI.yaml
+    - $ref: ../components/parameters/FSPIOP-HTTP-Method.yaml
+  requestBody:
+    description: Details of the transfer to be created.
+    required: true
+    content:
+      application/json:
+        schema:
+          $ref: ../components/schemas/Execute_FIToFICustomerCreditTransferV13.yaml
+  responses:
+    '202':
+      $ref: ../components/responses/202.yaml
+    '400':
+      $ref: ../components/responses/400.yaml
+    '401':
+      $ref: ../components/responses/401.yaml
+    '403':
+      $ref: ../components/responses/403.yaml
+    '404':
+      $ref: ../components/responses/404.yaml
+    '405':
+      $ref: ../components/responses/405.yaml
+    '406':
+      $ref: ../components/responses/406.yaml
+    '501':
+      $ref: ../components/responses/501.yaml
+    '503':
+      $ref: ../components/responses/503.yaml

package/fspiop/v2_0_ISO20022/openapi3/paths/transfers_{ID}.yaml

@@ -0,0 +1,119 @@
+parameters:
+  - $ref: ../components/parameters/ID.yaml
+  - $ref: ../components/parameters/Content-Type.yaml
+  - $ref: ../components/parameters/Date.yaml
+  - $ref: ../components/parameters/X-Forwarded-For.yaml
+  - $ref: ../components/parameters/FSPIOP-Source.yaml
+  - $ref: ../components/parameters/FSPIOP-Destination.yaml
+  - $ref: ../components/parameters/FSPIOP-Encryption.yaml
+  - $ref: ../components/parameters/FSPIOP-Signature.yaml
+  - $ref: ../components/parameters/FSPIOP-URI.yaml
+  - $ref: ../components/parameters/FSPIOP-HTTP-Method.yaml
+get:
+  description: >-
+    The HTTP request `GET /transfers/{ID}` is used to get information regarding
+    a transfer created or requested earlier. The `{ID}` in the URI should
+    contain the `transferId` that was used for the creation of the transfer.
+  summary: Retrieve transfer information
+  tags:
+    - transfers
+  operationId: TransfersByIDGet
+  parameters:
+    - $ref: ../components/parameters/Accept.yaml
+  responses:
+    '202':
+      $ref: ../components/responses/202.yaml
+    '400':
+      $ref: ../components/responses/400.yaml
+    '401':
+      $ref: ../components/responses/401.yaml
+    '403':
+      $ref: ../components/responses/403.yaml
+    '404':
+      $ref: ../components/responses/404.yaml
+    '405':
+      $ref: ../components/responses/405.yaml
+    '406':
+      $ref: ../components/responses/406.yaml
+    '501':
+      $ref: ../components/responses/501.yaml
+    '503':
+      $ref: ../components/responses/503.yaml
+patch:
+  description: >-
+    The HTTP request PATCH /transfers/<ID> is used by a Switch to update the
+    state of a previously reserved transfer, if the Payee FSP has requested a
+    commit notification when the Switch has completed processing of the
+    transfer. The <ID> in the URI should contain the transferId that was used
+    for the creation of the transfer. Please note that this request does not
+    generate a callback.
+  summary: Return transfer information
+  tags:
+    - transfers
+  operationId: TransfersByIDPatch
+  parameters:
+    - $ref: ../components/parameters/Content-Length.yaml
+  requestBody:
+    description: Transfer notification upon completion.
+    required: true
+    content:
+      application/json:
+        schema:
+          $ref: ../components/schemas/PacsStatus_FIToFIPaymentStatusReportV15.yaml
+  responses:
+    '200':
+      $ref: ../components/responses/200.yaml
+    '400':
+      $ref: ../components/responses/400.yaml
+    '401':
+      $ref: ../components/responses/401.yaml
+    '403':
+      $ref: ../components/responses/403.yaml
+    '404':
+      $ref: ../components/responses/404.yaml
+    '405':
+      $ref: ../components/responses/405.yaml
+    '406':
+      $ref: ../components/responses/406.yaml
+    '501':
+      $ref: ../components/responses/501.yaml
+    '503':
+      $ref: ../components/responses/503.yaml
+put:
+  description: >-
+    The callback `PUT /transfers/{ID}` is used to inform the client of a
+    requested or created transfer. The `{ID}` in the URI should contain the
+    `transferId` that was used for the creation of the transfer, or the `{ID}`
+    that was used in the `GET /transfers/{ID}` request.
+  summary: Return transfer information
+  tags:
+    - transfers
+  operationId: TransfersByIDPut
+  parameters:
+    - $ref: ../components/parameters/Content-Length.yaml
+  requestBody:
+    description: Transfer information returned.
+    required: true
+    content:
+      application/json:
+        schema:
+          $ref: ../components/schemas/PacsStatus_FIToFIPaymentStatusReportV15.yaml
+  responses:
+    '200':
+      $ref: ../components/responses/200.yaml
+    '400':
+      $ref: ../components/responses/400.yaml
+    '401':
+      $ref: ../components/responses/401.yaml
+    '403':
+      $ref: ../components/responses/403.yaml
+    '404':
+      $ref: ../components/responses/404.yaml
+    '405':
+      $ref: ../components/responses/405.yaml
+    '406':
+      $ref: ../components/responses/406.yaml
+    '501':
+      $ref: ../components/responses/501.yaml
+    '503':
+      $ref: ../components/responses/503.yaml

package/fspiop/v2_0_ISO20022/openapi3/paths/transfers_{ID}_error.yaml

@@ -0,0 +1,49 @@
+put:
+  description: >-
+    If the server is unable to find or create a transfer, or another processing
+    error occurs, the error callback `PUT /transfers/{ID}/error` is used. The
+    `{ID}` in the URI should contain the `transferId` that was used for the
+    creation of the transfer, or the `{ID}` that was used in the `GET
+    /transfers/{ID}`.
+  summary: Return transfer information error
+  tags:
+    - transfers
+  operationId: TransfersByIDAndError
+  parameters:
+    - $ref: ../components/parameters/ID.yaml
+    - $ref: ../components/parameters/Content-Length.yaml
+    - $ref: ../components/parameters/Content-Type.yaml
+    - $ref: ../components/parameters/Date.yaml
+    - $ref: ../components/parameters/X-Forwarded-For.yaml
+    - $ref: ../components/parameters/FSPIOP-Source.yaml
+    - $ref: ../components/parameters/FSPIOP-Destination.yaml
+    - $ref: ../components/parameters/FSPIOP-Encryption.yaml
+    - $ref: ../components/parameters/FSPIOP-Signature.yaml
+    - $ref: ../components/parameters/FSPIOP-URI.yaml
+    - $ref: ../components/parameters/FSPIOP-HTTP-Method.yaml
+  requestBody:
+    description: Details of the error returned.
+    required: true
+    content:
+      application/json:
+        schema:
+          $ref: ../components/schemas/PacsError_FIToFIPaymentStatusReportV15.yaml
+  responses:
+    '200':
+      $ref: ../components/responses/200.yaml
+    '400':
+      $ref: ../components/responses/400.yaml
+    '401':
+      $ref: ../components/responses/401.yaml
+    '403':
+      $ref: ../components/responses/403.yaml
+    '404':
+      $ref: ../components/responses/404.yaml
+    '405':
+      $ref: ../components/responses/405.yaml
+    '406':
+      $ref: ../components/responses/406.yaml
+    '501':
+      $ref: ../components/responses/501.yaml
+    '503':
+      $ref: ../components/responses/503.yaml