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

package/sdk-scheme-adapter/v2_1_0/outbound/paths/parties_Type_ID.yaml

@@ -1,18 +0,0 @@
-parameters:
-  - $ref: ../../components/parameters/Type.yaml
-  - $ref: ../../components/parameters/ID.yaml
-get:
-  description: >-
-    The HTTP request GET /parties// (or GET /parties///) is used to lookup
-    information regarding the requested Party, defined by ,  and optionally (for
-    example, GET /parties/MSISDN/123456789, or GET
-    /parties/BUSINESS/shoecompany/employee1).
-  summary: PartiesByTypeAndID
-  tags:
-    - parties
-  operationId: PartiesByTypeAndID
-  responses:
-    '200':
-      $ref: ../../components/responses/partiesByIdSuccess.yaml
-    '404':
-      $ref: ../../components/responses/partiesByIdError404.yaml

package/sdk-scheme-adapter/v2_1_0/outbound/paths/parties_Type_ID_SubId.yaml

@@ -1,19 +0,0 @@
-parameters:
-  - $ref: ../../components/parameters/Type.yaml
-  - $ref: ../../components/parameters/ID.yaml
-  - $ref: ../../components/parameters/SubId.yaml
-get:
-  description: >-
-    The HTTP request GET /parties// (or GET /parties///) is used to lookup
-    information regarding the requested Party, defined by ,  and optionally (for
-    example, GET /parties/MSISDN/123456789, or GET
-    /parties/BUSINESS/shoecompany/employee1).
-  summary: PartiesSubIdByTypeAndID
-  tags:
-    - parties
-  operationId: PartiesSubIdByTypeAndID
-  responses:
-    '200':
-      $ref: ../../components/responses/partiesByIdSuccess.yaml
-    '404':
-      $ref: ../../components/responses/partiesByIdError404.yaml

package/sdk-scheme-adapter/v2_1_0/outbound/paths/quotes.yaml

@@ -1,18 +0,0 @@
-post:
-  summary: Quotes endpoint
-  description: is used to request quotes from other DFSP
-  tags:
-    - quotes
-  operationId: QuotesPost
-  requestBody:
-    description: Quotes request payload
-    content:
-      application/json:
-        schema:
-          $ref: ../../components/schemas/simpleQuotesPostRequest.yaml
-    required: true
-  responses:
-    '200':
-      $ref: ../../components/responses/quotesPostSuccess.yaml
-    '500':
-      $ref: ../../components/responses/quotesServerError.yaml

package/sdk-scheme-adapter/v2_1_0/outbound/paths/requestToPay.yaml

@@ -1,22 +0,0 @@
-post:
-  summary: Receiver requesting funds from Sender
-  description: >
-    The HTTP request `POST /requestToPay` is used to support Pull Funds pattern
-    where in a receiver can request for funds from the Sender.
-
-    The underlying API has two stages:
-
-      1. Party lookup. This facilitates a check by the sending party that the destination party is correct before proceeding with a money movement.
-      2. Transaction Request. This request enables a Payee to request Payer to send electronic funds to the Payee.
-  tags:
-    - RequestToPay
-  requestBody:
-    description: RequestToPay request body
-    content:
-      application/json:
-        schema:
-          $ref: ../../components/schemas/requestToPayRequest.yaml
-    required: true
-  responses:
-    '200':
-      $ref: ../../components/responses/requestToPaySuccess.yaml

package/sdk-scheme-adapter/v2_1_0/outbound/paths/requestToPayTransfer.yaml

@@ -1,57 +0,0 @@
-post:
-  summary: >-
-    Used to trigger funds from customer fsp account to merchant fsp account.
-    This is a follow-up request to requestToPay.
-  description: >
-    The HTTP request `POST /requestToPayTransfer` is used to request the
-    movement of funds from payer DFSP to payee DFSP.
-
-    The underlying Mojaloop API has three stages for money transfer:
-
-      1. Quotation. This facilitates the exchange of fee information and the construction of a cryptographic "contract" between payee and payer DFSPs before funds are transferred.
-      2. Authorization. This facilitates getting OTP from payee DFSP.
-      3. Transfer. The enactment of the previously agreed "contract"
-
-    This method has several modes of operation.
-
-    - If the configuration variable `AUTO_ACCEPT_QUOTES` is set to `"false"`
-    this method will terminate and return the quotation when it has been
-    received from the payee DFSP.
-      If the payee wished to proceed with the otp, then a subsequent `PUT /transfers/{transferId}` request (accepting the quote) is required to continue the operation.
-      The scheme adapter will then proceed with the transfer state.
-
-    - If the configuration variable `AUTO_ACCEPT_OTP` is set to `"false"` this
-    method will terminate and return the otp when it has been received from the
-    payee DFSP.
-      If the payer wished to proceed with the transfer, then a subsequent `PUT /transfers/{transferId}` request (accepting the quote) is required to continue the operation.
-      The scheme adapter will then proceed with the transfer state.
-
-    If the configuration variables `AUTO_ACCEPT_PARTIES` and
-    `AUTO_ACCEPT_QUOTES` are both set to `"true"` this method will block until
-    all three transfer stages are complete. Upon completion it will return the
-    entire set of transfer details received during the operation.
-
-
-    Combinations of settings for `AUTO_ACCEPT...` configuration variables allow
-    the scheme adapter user to decide which mode of operation best suits their
-    use cases. i.e. the scheme adapter can be configured to "break" the three
-    stage transfer at these points in order to execute backend logic such as
-    party verification, quoted fees assessments etc...
-  tags:
-    - RequestToPayTransfer
-  requestBody:
-    description: Request To Pay Transfer request body
-    content:
-      application/json:
-        schema:
-          $ref: ../../components/schemas/requestToPayTransferRequest.yaml
-    required: true
-  responses:
-    '200':
-      $ref: ../../components/responses/requestToPayTransferSuccess.yaml
-    '400':
-      $ref: ../../components/responses/requestToPayTransferBadRequest.yaml
-    '500':
-      $ref: ../../components/responses/transferServerError.yaml
-    '504':
-      $ref: ../../components/responses/transferTimeout.yaml

package/sdk-scheme-adapter/v2_1_0/outbound/paths/requestToPayTransfer_transactionRequestId.yaml

@@ -1,34 +0,0 @@
-put:
-  summary: >-
-    Continues a transfer that has paused at the otp stage in order to accept or
-    reject quote
-  description: >
-    This request is used to continue a
-    requestToPayTransfer initiated via the `POST /requestToPayTransfer` method that has halted after
-    quotation stage and/or otp stage.
-
-
-    The request body should contain either the "acceptOTP" or "acceptQuote"
-    property set to `true` as required to continue the transfer.
-
-
-    See the description of the `POST /requestToPayTransfer` HTTP method for more
-    information on modes of transfer.
-  tags:
-    - RequestToPayTransferID
-  requestBody:
-    content:
-      application/json:
-        schema:
-          oneOf:
-            - $ref: ../../components/schemas/transferContinuationAcceptQuote.yaml
-            - $ref: ../../components/schemas/transferContinuationAcceptOTP.yaml
-  parameters:
-    - $ref: ../../components/parameters/transactionRequestId.yaml
-  responses:
-    '200':
-      $ref: ../../components/responses/transferSuccess.yaml
-    '500':
-      $ref: ../../components/responses/transferServerError.yaml
-    '504':
-      $ref: ../../components/responses/transferTimeout.yaml

package/sdk-scheme-adapter/v2_1_0/outbound/paths/requestToPay_transactionRequestId.yaml

@@ -1,29 +0,0 @@
-put:
-  summary: >-
-    Continues a request funds from sender that has paused at the party resolution stage in order to accept or
-    reject party information
-  description: >
-    The HTTP request `PUT /requestToPay/{transactionRequestId}` is used to continue a
-    transfer initiated via the `POST /requestToPay` method that has halted after
-    party lookup stage.
-
-    The request body should contain the "acceptParty" property set to `true` as required to continue the transfer.
-
-    See the description of the `POST /requestToPay` HTTP method for more
-    information on modes of transfer.
-  tags:
-    - RequestToPay
-  requestBody:
-    content:
-      application/json:
-        schema:
-          $ref: ../../components/schemas/transferContinuationAcceptParty.yaml
-  parameters:
-    - $ref: ../../components/parameters/transactionRequestId.yaml
-  responses:
-    '200':
-      $ref: ../../components/responses/requestToPaySuccess.yaml
-    '500':
-      $ref: ../../components/responses/transferServerError.yaml
-    '504':
-      $ref: ../../components/responses/transferTimeout.yaml

package/sdk-scheme-adapter/v2_1_0/outbound/paths/services_FXP.yaml

@@ -1,15 +0,0 @@
-get:
-  description: >-
-    The HTTP request `GET /services/FXP` is used to request information about the participants in a scheme who offer currency conversion services.
-  summary: Obtain a list of the DFSPs in the scheme who provide FXP service
-  tags:
-    - servicesFXP
-  operationId: ServicesFXPGet
-  responses:
-    '200':
-      $ref: ../../components/responses/servicesFXPSucess.yaml
-    '400':
-      $ref: ../../components/responses/400.yaml
-    '500':
-      $ref: ../../components/responses/500.yaml
-

package/sdk-scheme-adapter/v2_1_0/outbound/paths/services_FXP_SourceCurrency_TargetCurrency.yaml

@@ -1,18 +0,0 @@
-get:
-  description: >-
-    The HTTP request `GET /services/FXP/{SourceCurrency}/{TargetCurrency}` is used to request information about the participants in a scheme who offer currency conversion services in a particular currency corridor.
-    The required corridor is specified by giving the ISO 4217 currency code for the SourceCurrency and the TargetCurrency.
-  summary: Obtain a list of the DFSPs in the scheme who provide FXP service
-  tags:
-    - servicesFXP
-  operationId: ServicesFXPSourceCurrencyTargetCurrencyGet
-  parameters:
-    - $ref: ../../../../fspiop/v2_0/openapi3/components/parameters/SourceCurrency.yaml
-    - $ref: ../../../../fspiop/v2_0/openapi3/components/parameters/TargetCurrency.yaml
-  responses:
-    '200':
-      $ref: ../../components/responses/servicesFXPSucess.yaml
-    '400':
-      $ref: ../../components/responses/400.yaml
-    '500':
-      $ref: ../../components/responses/500.yaml

package/sdk-scheme-adapter/v2_1_0/outbound/paths/simpleTransfers.yaml

@@ -1,18 +0,0 @@
-post:
-  summary: Simple Transfers endpoint
-  description: is used to request a transfer
-  tags:
-    - transfers
-  operationId: SimpleTransfersPost
-  requestBody:
-    description: Simple Transfer request payload
-    content:
-      application/json:
-        schema:
-          $ref: ../../components/schemas/simpleTransfersPostRequest.yaml
-    required: true
-  responses:
-    '200':
-      $ref: ../../components/responses/simpleTransfersPostSuccess.yaml
-    '500':
-      $ref: ../../components/responses/simpleTransfersServerError.yaml

package/sdk-scheme-adapter/v2_1_0/outbound/paths/transfers.yaml

@@ -1,55 +0,0 @@
-post:
-  summary: Sends money from one account to another
-  description: >
-    The HTTP request `POST /transfers` is used to request the movement of funds
-    from payer DFSP to payee DFSP.
-
-    The underlying Mojaloop API has three stages for money transfer:
-
-      1. Party lookup. This facilitates a check by the sending party that the destination party is correct before proceeding with a money movement.
-      2. Quotation. This facilitates the exchange of fee information and the construction of a cryptographic "contract" between payee and payer DFSPs before funds are transferred.
-      3. Transfer. The enactment of the previously agreed "contract"
-
-    This method has several modes of operation.
-
-    - If the configuration variables `AUTO_ACCEPT_PARTIES` is set to `"false"`
-    this method will terminate when the payee party has been resolved and return
-    the payee party details.
-      If the payee wishes to proceed with the transfer, then a subsequent `PUT /transfers/{transferId}` request (accepting the payee party) is required to continue the operation.
-      The scheme adapter will then proceed with quotation stage...
-
-    - If the configuration variable `AUTO_ACCEPT_QUOTES` is set to `"false"`
-    this method will terminate and return the quotation when it has been
-    received from the payee DFSP.
-      If the payee wished to proceed with the transfer, then a subsequent `PUT /transfers/{transferId}` request (accepting the quote) is required to continue the operation.
-      The scheme adapter will then proceed with the transfer state.
-
-    If the configuration variables `AUTO_ACCEPT_PARTIES` and
-    `AUTO_ACCEPT_QUOTES` are both set to `"true"` this method will block until
-    all three transfer stages are complete. Upon completion it will return the
-    entire set of transfer details received during the operation.
-
-
-    Combinations of settings for `AUTO_ACCEPT...` configuration variables allow
-    the scheme adapter user to decide which mode of operation best suits their
-    use cases. i.e. the scheme adapter can be configured to "break" the three
-    stage transfer at these points in order to execute backend logic such as
-    party verification, quoted fees assessments etc...
-  tags:
-    - Transfers
-  requestBody:
-    description: Transfer request body
-    content:
-      application/json:
-        schema:
-          $ref: ../../components/schemas/transferRequest.yaml
-    required: true
-  responses:
-    '200':
-      $ref: ../../components/responses/transferSuccess.yaml
-    '400':
-      $ref: ../../components/responses/transferBadRequest.yaml
-    '500':
-      $ref: ../../components/responses/transferServerError.yaml
-    '504':
-      $ref: ../../components/responses/transferTimeout.yaml

package/sdk-scheme-adapter/v2_1_0/outbound/paths/transfers_transferId.yaml

@@ -1,59 +0,0 @@
-put:
-  summary: >-
-    Continues a transfer that has paused at the quote stage in order to accept
-    or reject payee party and/or quote and/or conversion
-  description: >
-    The HTTP request `PUT /transfers/{transferId}` is used to continue a
-    transfer initiated via the `POST /transfers` method that has halted after
-    party lookup and/or quotation stage and/or currency conversion stage.
-
-
-    The request body should contain either the "acceptParty" or "acceptQuote" or "acceptConversion"
-    property set to `true` as required to continue the transfer.
-
-
-    See the description of the `POST /transfers` HTTP method for more
-    information on modes of transfer.
-  tags:
-    - Transfers
-  requestBody:
-    content:
-      application/json:
-        schema:
-          oneOf:
-            - $ref: ../../components/schemas/transferContinuationAcceptParty.yaml
-            - $ref: ../../components/schemas/transferContinuationAcceptQuote.yaml
-            - $ref: ../../components/schemas/transferContinuationAcceptConversion.yaml
-  parameters:
-    - $ref: ../../components/parameters/transferId.yaml
-  responses:
-    '200':
-      $ref: ../../components/responses/transferSuccess.yaml
-    '500':
-      $ref: ../../components/responses/transferServerError.yaml
-    '504':
-      $ref: ../../components/responses/transferTimeout.yaml
-get:
-  summary: Retrieves information for a specific transfer
-  description: >-
-    The HTTP request `GET /transfers/{transferId}` is used to get information
-    regarding a transfer created or requested earlier. The `{transferId}` in the
-    URI should contain the `transferId` that was used for the creation of the
-    transfer.
-  tags:
-    - Transfers
-  parameters:
-    - $ref: ../../components/parameters/transferId.yaml
-  responses:
-    '200':
-      description: Transfer information successfully retrieved
-      content:
-        application/json:
-          schema:
-            $ref: ../../components/schemas/transferStatusResponse.yaml
-    '500':
-      description: An error occurred processing the transfer
-      content:
-        application/json:
-          schema:
-            $ref: ../../components/schemas/errorResponse.yaml

package/sdk-scheme-adapter/v2_1_0/outbound/paths.yaml

@@ -1,12 +0,0 @@
-get:
-  summary: Health check endpoint
-  description: >-
-    This endpoint allows a user of the SDK scheme adapter to check the outbound
-    transfers service is listening.
-  tags:
-    - Health
-  responses:
-    '200':
-      description: >-
-        Returns empty body if the scheme adapter outbound transfers service is
-        running.