@mojaloop/api-snippets 18.3.1 → 18.4.0

package/thirdparty/v2_0/openapi3/paths/tppTransfers_ID.yaml

@@ -0,0 +1,86 @@
+parameters:
+  #Path
+  - $ref: ../components/parameters/ID.yaml
+  #Headers
+  - $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:
+  tags:
+    - transfers
+  operationId: tppGetTransfers
+  summary: tppGetTransfers
+  description: |
+    The HTTP request `GET /tppTransfers/{ID}` is used to request the
+    retrieval of a third party transaction request.
+  parameters:
+    #Headers
+    - $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:
+  tags:
+    - transfers
+  operationId: tppUpdateTransfersRequest
+  summary: tppUpdateTransfersRequest
+  description: |
+    The HTTP request `PUT /tppTransfers/{ID}` is used by the DFSP to inform the client about
+    the status of a previously requested thirdparty transaction request. The ID is the executionRequestId that was provided in the corresponding POST request.
+
+    Switch(Thirdparty API Adapter) -> PISP
+  parameters:
+    #Headers
+    - $ref: ../components/parameters/Content-Length.yaml
+  requestBody:
+    required: true
+    content:
+      application/json:
+        schema:
+          $ref: ../components/schemas/tppTransfersPutResponse.yaml
+        example:
+          transactionRequestState: 'RECEIVED'
+  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/thirdparty/v2_0/openapi3/paths/tppTransfers_ID_error.yaml

@@ -0,0 +1,52 @@
+parameters:
+  #Path
+  - $ref: ../components/parameters/ID.yaml
+  #Headers
+  - $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
+put:
+  tags:
+    - transfers
+  operationId: tppTransfersRequestsError
+  summary: tppTransfersRequestsError
+  description: |
+    If the server is unable to find the transaction request, or another processing error occurs,
+    the error callback `PUT /tppTransfers/{ID}/error` is used.
+    The `{ID}` in the URI should contain the `transactionRequestId` that was used for the creation of
+    the thirdparty transaction request.
+  parameters:
+    #Headers
+    - $ref: ../components/parameters/Content-Length.yaml
+  requestBody:
+    description: Error information returned.
+    required: true
+    content:
+      application/json:
+        schema:
+          $ref: '../../../../fspiop/v2_0/openapi3/components/schemas/ErrorInformationObject.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/thirdparty/v2_0/openapi3/paths/tppVerifications.yaml

@@ -0,0 +1,49 @@
+parameters:
+  #Headers
+  - $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
+post:
+  tags:
+    - verifications
+  operationId: tppPostVerifications
+  summary: tppPostVerifications
+  description: |
+    The HTTP request `POST /tppVerifications` is used by the DFSP to verify a third party authorization in cases where the authentication service to be used is implemented by the switch and not internally by the DFSP. 
+  parameters:
+    - $ref: ../components/parameters/Accept.yaml
+    - $ref: ../components/parameters/Content-Length.yaml
+  requestBody:
+    description: The thirdparty authorization details to verify
+    required: true
+    content:
+      application/json:
+        schema:
+            oneOf:
+              - $ref: ../components/schemas/tppVerificationsPostRequestFIDO.yaml
+              - $ref: ../components/schemas/tppVerificationsPostRequestGeneric.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/thirdparty/v2_0/openapi3/paths/tppVerifications_ID.yaml

@@ -0,0 +1,87 @@
+parameters:
+  #Path
+  - $ref: ../components/parameters/ID.yaml
+  #Headers
+  - $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:
+  tags:
+    - verifications
+  operationId: tppGetVerificationsById
+  summary: tppGetVerificationsById
+  description: |
+    The HTTP request `/tppVerifications/{ID}` is used to get
+    information regarding a previously created or requested authorization. The *{ID}*
+    in the URI should contain the verification request ID
+  parameters:
+    #Headers
+    - $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:
+  tags:
+    - verifications
+  operationId: tppPutVerificationsById
+  summary: tppPutVerificationsById
+  description: >-
+    The HTTP request `PUT /tppVerifications/{ID}` is used by the Auth-Service to inform
+    the DFSP of a successful result in validating the verification of a Thirdparty Transaction Request.
+
+    If the validation fails, the auth-service will send back `PUT /tppVerifications/{ID}`
+    with `authenticationResponse: 'REJECTED'`.
+
+    In unplanned error cases the Auth-Service MUST use `PUT /tppVerifications/{ID}/error`.
+  parameters:
+    - $ref: ../components/parameters/Content-Length.yaml
+  requestBody:
+    description: The result of validating the Thirdparty Transaction Request
+    required: true
+    content:
+      application/json:
+        schema:
+          $ref: ../components/schemas/tppVerificationsIDPutResponse.yaml
+        example:
+          authenticationResponse: 'VERIFIED'
+  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/thirdparty/v2_0/openapi3/paths/tppVerifications_ID_error.yaml

@@ -0,0 +1,49 @@
+parameters:
+  #Path
+  - $ref: ../components/parameters/ID.yaml
+  #Headers
+  - $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
+put:
+  tags:
+    - verifications
+  operationId: tppPutVerificationsByIdAndError
+  summary: tppPutVerificationsByIdAndError
+  description: |
+    The HTTP request `PUT /tppVerifications/{ID}/error` is used by the Auth-Service to inform
+    the DFSP of a failure in validating or looking up the verification of a Thirdparty Transaction Request.
+  parameters:
+    - $ref: ../components/parameters/Content-Length.yaml
+  requestBody:
+    description: Error information returned.
+    required: true
+    content:
+      application/json:
+        schema:
+          $ref: '../../../../fspiop/v2_0/openapi3/components/schemas/ErrorInformationObject.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/thirdparty/v2_0/openapi3/thirdparty-dfsp-admin-api.template.yaml

@@ -0,0 +1,53 @@
+openapi: 3.0.2
+info:
+  title: Mojaloop Third Party Admin API for DFSPs
+  version: '2.0'
+  description: >
+    A Mojaloop API for DFSPs supporting Third Party functions.
+
+    DFSPs who want to enable Payment Initiation Service Providers
+    (PISPs) to perform actions on behalf of a DFSP's user should 
+    implement this API.
+
+    PISPs should implement the accompanying API - Mojaloop Third 
+    Party API (PISP) instead.
+  license:
+    name: Open API for FSP Interoperability (FSPIOP) (Implementation Friendly Version)
+    url: https://github.com/mojaloop/mojaloop-specification/blob/main/LICENSE.md
+servers:
+  - url: /
+paths:
+  /tppAccountRequest:
+    $ref: paths/tppAccountRequest.yaml
+  /tppAccountRequest/{ID}:
+    $ref: paths/tppAccountRequest_ID.yaml
+  /tppAccountRequest/{ID}/error:
+    $ref: paths/tppAccountRequest_ID_error.yaml
+  /tppAccounts/{ID}:
+    $ref: 'paths/tppAccounts_ID.yaml'
+  /tppAccounts/{ID}/error:
+    $ref: 'paths/tppAccounts_ID_error.yaml'
+  /tppConsentRequests:
+    $ref: 'paths/tppConsentRequests.yaml'
+  /tppConsentRequests/{ID}:
+    $ref: 'paths/tppConsentRequests_ID.yaml'
+  /tppConsentRequests/{ID}/error:
+    $ref: 'paths/tppConsentRequests_ID_error.yaml'
+  /tppConsents:
+    $ref: 'paths/tppConsents.yaml'
+  /tppConsents/{ID}:
+    $ref: 'paths/tppConsents_ID.yaml'
+  /tppConsents/{ID}/error:
+    $ref: 'paths/tppConsents_ID_error.yaml'
+  /tppVerifications:
+    $ref: 'paths/tppVerifications.yaml'
+  /tppVerifications/{ID}:
+    $ref: 'paths/tppVerifications_ID.yaml'
+  /tppVerifications/{ID}/error:
+    $ref: 'paths/tppVerifications_ID_error.yaml'
+  /tppAuthorizations:
+    $ref: 'paths/tppAuthorizations.yaml'
+  /tppAuthorizations/{ID}:
+    $ref: 'paths/tppAuthorizations_ID.yaml'
+  /tppAuthorizations/{ID}/error:
+    $ref: 'paths/tppAuthorizations_ID_error.yaml'