@mojaloop/api-snippets 17.2.4 → 17.3.0-snapshot.0

package/fspiop/v2_0/openapi3/paths/fxQuotes_ID_error.yaml

@@ -0,0 +1,49 @@
+put:
+  description: >-
+    If the FXP is unable to find or create a FX quote, or some other processing
+    error occurs, the error callback `PUT /fxQuotes/{ID}/error` is used. The
+    `{ID}` in the URI should contain the `conversionRequestId` that was used for the
+    creation of the FX quote, or the `{ID}` that was used in the `GET /fxQuotes/{ID}`
+    request.
+  summary: Return FX quote information error
+  tags:
+    - fxQuotes
+  operationId: FxQuotesByIDAndErrorPut
+  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/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/fspiop/v2_0/openapi3/paths/fxTransfers.yaml

@@ -0,0 +1,45 @@
+post:
+  description: >-
+    The HTTP request `POST /fxTransfers` is used to ask an FXP to confirm the execution of an agreed currency conversion.
+  summary: Perform FX transfer
+  tags:
+    - fxTransfers
+  operationId: FxTransfersPost
+  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 FX transfer to be created.
+    required: true
+    content:
+      application/json:
+        schema:
+          $ref: ../components/schemas/FxTransfersPostRequest.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/openapi3/paths/fxTransfers_ID.yaml

@@ -0,0 +1,118 @@
+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 /fxTransfers/{ID}` s used to request information regarding a request for confirmation
+    of a currency conversion which the sender has previously issued. The `{ID}` in the URI should
+    contain the `commitRequestId` that was used for the creation of the FX transfer.
+  summary: Retrieve FX transfer information
+  tags:
+    - fxTransfers
+  operationId: FxTransfersByIDGet
+  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 /fxTransfers/<ID> is used to inform the requester about
+    the final determination by the switch of the transfer a request for execution of a currency conversion.
+    The <ID> in the URI should contain the commitRequestId that was used
+    for the creation of the FX transfer. Please note that this request does not
+    generate a callback.
+  summary: Return FX transfer information
+  tags:
+    - fxTransfers
+  operationId: FxTransfersByIDPatch
+  parameters:
+    - $ref: ../components/parameters/Content-Length.yaml
+  requestBody:
+    description: Transfer notification upon completion.
+    required: true
+    content:
+      application/json:
+        schema:
+          $ref: ../components/schemas/FxTransfersIDPatchResponse.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 /fxTransfers/{ID}` is used to inform the requester about the
+    outcome of a request for execution of a currency conversion. The `{ID}` in the URI should contain the
+    `commitRequestId` that was used for the creation of the FX transfer, or the `{ID}`
+    that was used in the `GET /fxTransfers/{ID}` request.
+  summary: Return FX transfer information
+  tags:
+    - fxTransfers
+  operationId: FxTransfersByIDPut
+  parameters:
+    - $ref: ../components/parameters/Content-Length.yaml
+  requestBody:
+    description: Transfer information returned.
+    required: true
+    content:
+      application/json:
+        schema:
+          $ref: ../components/schemas/FxTransfersIDPutResponse.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/openapi3/paths/fxTransfers_ID_error.yaml

@@ -0,0 +1,49 @@
+put:
+  description: >-
+    If the switch or FXP is unable to find or create a FX transfer, or another processing
+    error occurs, the error callback `PUT /fxTransfers/{ID}/error` is used. The
+    `{ID}` in the URI should contain the `commitRequestId` that was used for the
+    creation of the FX transfer, or the `{ID}` that was used in the `GET
+    /fxTransfers/{ID}`.
+  summary: Return FX transfer information error
+  tags:
+    - fxTransfers
+  operationId: FxTransfersByIDAndErrorPut
+  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/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/fspiop/v2_0/openapi3/paths/participants.yaml

@@ -0,0 +1,49 @@
+post:
+  description: >-
+    The HTTP request `POST /participants` is used to create information in the
+    server regarding the provided list of identities. This request should be
+    used for bulk creation of FSP information for more than one Party. The
+    optional currency parameter should indicate that each provided Party
+    supports the currency.
+  summary: Create bulk participant information
+  tags:
+    - participants
+  operationId: Participants1
+  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: Participant information to be created.
+    required: true
+    content:
+      application/json:
+        schema:
+          $ref: ../components/schemas/ParticipantsPostRequest.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/openapi3/paths/participants_ID.yaml

@@ -0,0 +1,46 @@
+put:
+  description: >-
+    The callback `PUT /participants/{ID}` is used to inform the client of the
+    result of the creation of the provided list of identities.
+  summary: Return bulk participant information
+  tags:
+    - participants
+  operationId: putParticipantsByID
+  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: Participant information returned.
+    required: true
+    content:
+      application/json:
+        schema:
+          $ref: ../components/schemas/ParticipantsIDPutResponse.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/openapi3/paths/participants_ID_error.yaml

@@ -0,0 +1,48 @@
+put:
+  description: >-
+    If there is an error during FSP information creation in the server, the
+    error callback `PUT /participants/{ID}/error` is used. The `{ID}` in the URI
+    should contain the requestId that was used for the creation of the
+    participant information.
+  summary: Return bulk participant information error
+  tags:
+    - participants
+  operationId: ParticipantsByIDAndError
+  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/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/fspiop/v2_0/openapi3/paths/participants_Type_ID.yaml

@@ -0,0 +1,167 @@
+parameters:
+  - $ref: ../components/parameters/Type.yaml
+  - $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
+post:
+  description: >-
+    The HTTP request `POST /participants/{Type}/{ID}` (or `POST
+    /participants/{Type}/{ID}/{SubId}`) is used to create information in the
+    server regarding the provided identity, defined by `{Type}`, `{ID}`, and
+    optionally `{SubId}` (for example, `POST /participants/MSISDN/123456789` or
+    `POST /participants/BUSINESS/shoecompany/employee1`). An ExtensionList
+    element has been added to this reqeust in version v1.1
+  summary: Create participant information
+  tags:
+    - participants
+  operationId: ParticipantsByIDAndType
+  parameters:
+    - $ref: ../components/parameters/Accept.yaml
+    - $ref: ../components/parameters/Content-Length.yaml
+  requestBody:
+    description: Participant information to be created.
+    required: true
+    content:
+      application/json:
+        schema:
+          $ref: ../components/schemas/ParticipantsTypeIDSubIDPostRequest.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
+get:
+  description: >-
+    The HTTP request `GET /participants/{Type}/{ID}` (or `GET
+    /participants/{Type}/{ID}/{SubId}`) is used to find out in which FSP the
+    requested Party, defined by `{Type}`, `{ID}` and optionally `{SubId}`, is
+    located (for example, `GET /participants/MSISDN/123456789`, or `GET
+    /participants/BUSINESS/shoecompany/employee1`). This HTTP request should
+    support a query string for filtering of currency. To use filtering of
+    currency, the HTTP request `GET /participants/{Type}/{ID}?currency=XYZ`
+    should be used, where `XYZ` is the requested currency.
+  summary: Look up participant information
+  tags:
+    - participants
+  operationId: ParticipantsByTypeAndID
+  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 /participants/{Type}/{ID}` (or `PUT
+    /participants/{Type}/{ID}/{SubId}`) is used to inform the client of a
+    successful result of the lookup, creation, or deletion of the FSP
+    information related to the Party. If the FSP information is deleted, the
+    fspId element should be empty; otherwise the element should include the FSP
+    information for the Party.
+  summary: Return participant information
+  tags:
+    - participants
+  operationId: ParticipantsByTypeAndID3
+  parameters:
+    - $ref: ../components/parameters/Content-Length.yaml
+  requestBody:
+    description: Participant information returned.
+    required: true
+    content:
+      application/json:
+        schema:
+          $ref: ../components/schemas/ParticipantsTypeIDPutResponse.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
+delete:
+  description: >-
+    The HTTP request `DELETE /participants/{Type}/{ID}` (or `DELETE
+    /participants/{Type}/{ID}/{SubId}`) is used to delete information in the
+    server regarding the provided identity, defined by `{Type}` and `{ID}`) (for
+    example, `DELETE /participants/MSISDN/123456789`), and optionally `{SubId}`.
+    This HTTP request should support a query string to delete FSP information
+    regarding a specific currency only. To delete a specific currency only, the
+    HTTP request `DELETE /participants/{Type}/{ID}?currency=XYZ` should be used,
+    where `XYZ` is the requested currency.
+
+
+    **Note:** The Account Lookup System should verify that it is the Party’s
+    current FSP that is deleting the FSP information.
+  summary: Delete participant information
+  tags:
+    - participants
+  operationId: ParticipantsByTypeAndID2
+  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