@mojaloop/api-snippets 18.3.1 → 18.4.0

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

@@ -0,0 +1,49 @@
+parameters:
+  #Path
+  - $ref: ../components/parameters/ServiceType.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:
+  description: |
+    The HTTP request `PUT /services/{ServiceType}/error` is used to return error information
+  operationId: PutServicesByServiceTypeAndError
+  summary: PutServicesByServiceTypeAndError
+  tags:
+    - services
+  parameters:
+    - $ref: ../components/parameters/Content-Length.yaml
+  requestBody:
+    description: Details of the error 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/tppAccountRequest.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:
+    - accountRequest
+  operationId: AuthorisingAccountRequest
+  summary: AuthorisingAccountRequest
+  description: |
+    The `/tppAccountsRequest` resource is used to request consent from a user 
+    for access to their accounts information. This resource must be called before 
+    the /tppAccounts resource can be queried which provides the account information. 
+  parameters:
+    - $ref: ../components/parameters/Accept.yaml
+    - $ref: ../components/parameters/Content-Length.yaml
+  requestBody:
+    description: The consentRequest to create
+    required: true
+    content:
+      application/json:
+        schema:
+          $ref: ../components/schemas/tppAccountRequestPostRequest.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/tppAccountRequest_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:
+  operationId: GetAccountRequest
+  summary: GetAccountRequest
+  description: |
+    The `GET /tppAccountsRequest/{ID}` is used to request status of POST /tppAccountRequest/ call.
+    The *{ID}* in the URI should contain the accountRequestId that was assigned to the
+    request by the PISP when the PISP originated the request. The result is return via the PUT callback.
+  tags:
+    - accountRequest
+  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:
+  tags:
+    - accountRequest
+  operationId: UpdateAccountRequest
+  summary: UpdateAccountRequest
+  description: |
+    A DFSP uses this callback to (1) inform the PISP that the accountRequest has been accepted,
+    and (2) communicate to the PISP which `authChannel` it should use to authenticate their user
+    with.
+
+    When a PISP requests a series of permissions from a DFSP on behalf of a DFSP's customer, 
+    not all the permissions requested may be granted by the DFSP. 
+    Conversely, the out-of-loop authorization process may result in additional privileges 
+    being granted by the account holder to the PISP. The `PUT /tppAccountsRequest/<ID>` 
+    resource returns the current state of the permissions relating to a particular 
+    authorization request.
+  parameters:
+    - $ref: ../components/parameters/Content-Length.yaml
+  requestBody:
+    required: true
+    content:
+      application/json:
+        schema:
+          $ref: ../components/schemas/tppAccountRequestPutResponse.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/tppAccountRequest_ID_error.yaml

@@ -0,0 +1,48 @@
+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:
+    - accountRequest
+  operationId: NotifyErrorAccountRequest
+  summary: NotifyErrorAccountRequest
+  description: |
+    DFSP responds to the PISP if something went wrong with validating an OTP or secret.
+  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/paths/tppAccounts_ID.yaml

@@ -0,0 +1,88 @@
+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:
+  operationId: GetAccountsByUserId
+  summary: GetAccountsByUserId
+  description: |
+    The HTTP request `GET /tppAccounts/{ID}/{SignedChallenge}` is used to retrieve the list of potential accounts available for linking.
+    The request `{ID}` is the accountRequestID and the `{SignedChallenge}` is the signed challenge that resulted from the `POST /tppAccountRequest/` callback. 
+    
+    The signed challenge must match the authentication channel that was selected by the DFSP. For example, if the WEB authentication channel was selected by the DFSP, then signed challenge needs to be authToken, otherwise if the OTP channel was selected, then it needs to be the OTP that was entered by the party.
+    (For example, GET /tppAccounts/12345/56789).
+  tags:
+    - accounts
+  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 HTTP request `PUT /tppAccounts/{ID}` is used to return the list of potential accounts available for linking
+  operationId: UpdateAccountsByUserId
+  summary: UpdateAccountsByUserId
+  tags:
+    - accounts
+  parameters:
+    - $ref: ../components/parameters/Content-Length.yaml
+  requestBody:
+    required: true
+    content:
+      application/json:
+        schema:
+          $ref: ../components/schemas/tppAccountsIDPutResponse.yaml
+        example:
+        -
+          accountNickname: 'dfspa.user.nickname1'
+          id: 'dfspa.username.1234'
+          currency: 'ZAR'
+        -
+          accountNickname: 'dfspa.user.nickname2'
+          id: 'dfspa.username.5678'
+          currency: 'USD'
+  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/tppAccounts_ID_error.yaml

@@ -0,0 +1,48 @@
+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:
+  description: |
+    The HTTP request `PUT /ttpAccounts/{ID}/error` is used to return error information
+  operationId: UpdateAccountsByUserIdError
+  summary: UpdateAccountsByUserIdError
+  tags:
+    - accounts
+  parameters:
+    - $ref: ../components/parameters/Content-Length.yaml
+  requestBody:
+    description: Details of the error 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/tppAuthorizations.yaml

@@ -0,0 +1,51 @@
+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:
+  description:  >
+    The HTTP request **POST /tppAuthorizations** used by a Payer DFSP to request authorization from the Payer to make a payment. 
+
+    This use case is applicable when the Payer DFSP receives a request to pay (a Payee initiated payment) and chooses to authorize the payment through the third party provider. 
+    
+  operationId: tppPostAuthorizations
+  summary: tppPostAuthorizations
+  tags:
+    - authorizations
+  parameters:
+    #Headers
+    - $ref: ../components/parameters/Accept.yaml
+    - $ref: ../components/parameters/Content-Length.yaml
+  requestBody:
+    description: Authorization request details
+    required: true
+    content:
+      application/json:
+        schema:
+          $ref: ../components/schemas/tppAuthorizationsPostRequest.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/tppAuthorizations_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:
+  description: |
+    The HTTP request **GET /tppAuthorizations/**_{ID}_ is used to get information relating
+    to a previously issued authorization request. The *{ID}* in the request should match the
+    `authorizationRequestId` which was given when the authorization request was created.
+  operationId: tppGetAuthorizationsById
+  summary: ttpGetAuthorizationsById
+  tags:
+    - authorizations
+  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: |
+    After receiving the **POST /tppAuthorizations**, the PISP will present the details of the
+    transaction to their user, and request that the client sign the `challenge` field using the credential
+    they previously registered.
+
+    The signed challenge will be sent back by the PISP in **PUT /tppAuthorizations/**_{ID}_:
+
+  operationId: tppPutAuthorizationsById
+  summary: tppPutAuthorizationsById
+  tags:
+    - authorizations
+  parameters:
+    - $ref: ../components/parameters/Content-Length.yaml
+  requestBody:
+    description: Signed authorization object
+    required: true
+    content:
+      application/json:
+        schema:
+          oneOf:
+            - $ref: '../components/schemas/tppAuthorizationsIDPutResponseRejected.yaml'
+            - $ref: '../components/schemas/tppAuthorizationsIDPutResponseFIDO.yaml'
+            - $ref: '../components/schemas/tppAuthorizationsIDPutResponseGeneric.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/tppAuthorizations_ID_error.yaml

@@ -0,0 +1,55 @@
+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:
+    - authorizations
+  operationId: tppAuthorizationsByIdAndError
+  summary: tppAuthorizationsByIdAndError
+  description: |
+    The HTTP request `PUT /tppAuthorizations/{ID}/error` is used by the DFSP or PISP to inform
+    the other party that something went wrong with a Thirdparty Transaction Authorization Request.
+
+    The PISP may use this to tell the DFSP that the Thirdparty Transaction Authorization Request is invalid or doesn't
+    match a `transactionRequestId`.
+
+    The DFSP may use this to tell the PISP that the signed challenge returned in `PUT /tppAuthorizations/{ID}`
+    was invalid.
+  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/paths/tppConsentRequests.yaml

@@ -0,0 +1,48 @@
+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:
+    - consentRequests
+  operationId: CreateConsentRequest
+  summary: CreateConsentRequest
+  description: |
+    The HTTP request **POST /tppConsentRequests** is used to request a DFSP to grant access to one or more
+    accounts owned by a customer of the DFSP for the PISP who sends the request.
+  parameters:
+    - $ref: ../components/parameters/Accept.yaml
+    - $ref: ../components/parameters/Content-Length.yaml
+  requestBody:
+    description: The consentRequest to create
+    required: true
+    content:
+      application/json:
+        schema:
+          $ref: ../components/schemas/ConsentRequestsPostRequest.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