@mojaloop/api-snippets 17.0.4 → 17.0.5-snapshot.1

package/docs/sdk-scheme-adapter-backend-v2_0_0-openapi3-snippets.yaml

@@ -1348,7 +1348,7 @@ components:
       properties:
         transactionId:
           $ref: '#/components/schemas/transactionId'
-        transferAmount:
+        transactionRequestState:
           $ref: '#/components/schemas/transactionRequestState'
       required:
         - transactionId

package/docs/sdk-scheme-adapter-outbound-v2_0_0-openapi3-snippets.yaml

@@ -294,6 +294,38 @@ paths:
       responses:
         '200':
           $ref: '#/components/responses/requestToPaySuccess'
+  /requestToPay/{requestToPayId}:
+    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/{requestToPayId}` 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'
+      parameters:
+        - $ref: '#/components/parameters/requestToPayId'
+      responses:
+        '200':
+          $ref: '#/components/responses/requestToPaySuccess'
+        '500':
+          $ref: '#/components/responses/transferServerError'
+        '504':
+          $ref: '#/components/responses/transferTimeout'
   /requestToPayTransfer:
     post:
       summary: >-
@@ -2081,80 +2113,30 @@ components:
           $ref: '#/components/schemas/TransactionScenario'
         subScenario:
           $ref: '#/components/schemas/TransactionSubScenario'
-    AuthenticationType:
-      title: AuthenticationType
-      type: string
-      enum:
-        - OTP
-        - QRCODE
-        - U2F
-      description: |-
-        Below are the allowed values for the enumeration AuthenticationType.
-        - OTP - One-time password generated by the Payer FSP.
-        - QRCODE - QR code used as One Time Password.
-        - U2F - U2F is a new addition isolated to Thirdparty stream.
-      example: OTP
-    TransactionRequestState:
-      title: TransactionRequestState
+    transferStatus:
       type: string
       enum:
-        - RECEIVED
-        - PENDING
-        - ACCEPTED
-        - REJECTED
-      description: |-
-        Below are the allowed values for the enumeration.
-        - RECEIVED - Payer FSP has received the transaction from the Payee FSP.
-        - PENDING - Payer FSP has sent the transaction request to the Payer.
-        - ACCEPTED - Payer has approved the transaction.
-        - REJECTED - Payer has rejected the transaction.
-      example: RECEIVED
+        - ERROR_OCCURRED
+        - WAITING_FOR_PARTY_ACCEPTANCE
+        - WAITING_FOR_QUOTE_ACCEPTANCE
+        - COMPLETED
     requestToPayResponse:
       type: object
       required:
-        - transactionRequestId
+        - requestToPayId
         - from
         - to
         - amountType
         - currency
         - amount
         - transactionType
-        - requestToPayState
+        - currentState
       properties:
+        requestToPayId:
+          $ref: '#/components/schemas/CorrelationId'
         transactionRequestId:
           $ref: '#/components/schemas/CorrelationId'
-        from:
-          $ref: '#/components/schemas/transferParty'
-        to:
-          $ref: '#/components/schemas/transferParty'
-        amountType:
-          $ref: '#/components/schemas/AmountType'
-        currency:
-          $ref: '#/components/schemas/Currency'
-        amount:
-          $ref: '#/components/schemas/Amount'
-        transactionType:
-          $ref: '#/components/schemas/TransactionScenario'
-        subScenario:
-          $ref: '#/components/schemas/TransactionSubScenario'
-        authenticationType:
-          $ref: '#/components/schemas/AuthenticationType'
-        requestToPayState:
-          $ref: '#/components/schemas/TransactionRequestState'
-    requestToPayTransferRequest:
-      type: object
-      required:
-        - requestToPayTransactionId
-        - from
-        - to
-        - amountType
-        - currency
-        - amount
-        - scenario
-        - initiator
-        - initiatorType
-      properties:
-        requestToPayTransactionId:
+        homeTransactionId:
           type: string
           description: >-
             Transaction ID from the DFSP backend, used to reconcile transactions
@@ -2169,21 +2151,28 @@ components:
           $ref: '#/components/schemas/Currency'
         amount:
           $ref: '#/components/schemas/Amount'
-        scenario:
-          $ref: '#/components/schemas/TransactionType'
-        initiator:
-          $ref: '#/components/schemas/TransactionInitiator'
-        initiatorType:
-          $ref: '#/components/schemas/TransactionInitiatorType'
-        note:
-          $ref: '#/components/schemas/Note'
-    transferStatus:
-      type: string
-      enum:
-        - ERROR_OCCURRED
-        - WAITING_FOR_PARTY_ACCEPTANCE
-        - WAITING_FOR_QUOTE_ACCEPTANCE
-        - COMPLETED
+        transactionType:
+          $ref: '#/components/schemas/TransactionScenario'
+        subScenario:
+          $ref: '#/components/schemas/TransactionSubScenario'
+        currentState:
+          $ref: '#/components/schemas/transferStatus'
+        getPartiesResponse:
+          type: object
+          required:
+            - body
+          properties:
+            body:
+              type: object
+            headers:
+              type: object
+        lastError:
+          description: >
+            Object representing the last error to occur during a transfer
+            process. This may be a Mojaloop API error returned from another
+            entity in the scheme or an object representing other types of error
+            e.g. exceptions that may occur inside the scheme adapter.
+          $ref: '#/components/schemas/transferError'
     QuotesIDPutResponse:
       title: QuotesIDPutResponse
       type: object
@@ -2227,10 +2216,10 @@ components:
           $ref: '#/components/schemas/ExtensionList'
       required:
         - transferState
-    requestToPayTransferResponse:
+    transferResponse:
       type: object
       required:
-        - requestToPayTransactionId
+        - homeTransactionId
         - from
         - to
         - amountType
@@ -2240,7 +2229,7 @@ components:
       properties:
         transferId:
           $ref: '#/components/schemas/CorrelationId'
-        requestToPayTransactionId:
+        homeTransactionId:
           type: string
           description: >-
             Transaction ID from the DFSP backend, used to reconcile transactions
@@ -2257,14 +2246,32 @@ components:
           $ref: '#/components/schemas/Amount'
         transactionType:
           $ref: '#/components/schemas/transferTransactionType'
+        subScenario:
+          $ref: '#/components/schemas/TransactionSubScenario'
         note:
           $ref: '#/components/schemas/Note'
         currentState:
           $ref: '#/components/schemas/transferStatus'
         quoteId:
           $ref: '#/components/schemas/CorrelationId'
+        getPartiesResponse:
+          type: object
+          required:
+            - body
+          properties:
+            body:
+              type: object
+            headers:
+              type: object
         quoteResponse:
-          $ref: '#/components/schemas/QuotesIDPutResponse'
+          type: object
+          required:
+            - body
+          properties:
+            body:
+              $ref: '#/components/schemas/QuotesIDPutResponse'
+            headers:
+              type: object
         quoteResponseSource:
           type: string
           description: >
@@ -2273,7 +2280,14 @@ components:
             account in the case of a FOREX transfer. i.e. it may be a FOREX
             gateway.
         fulfil:
-          $ref: '#/components/schemas/TransfersIDPutResponse'
+          type: object
+          required:
+            - body
+          properties:
+            body:
+              $ref: '#/components/schemas/TransfersIDPutResponse'
+            headers:
+              type: object
         lastError:
           description: >
             Object representing the last error to occur during a transfer
@@ -2281,10 +2295,61 @@ components:
             entity in the scheme or an object representing other types of error
             e.g. exceptions that may occur inside the scheme adapter.
           $ref: '#/components/schemas/transferError'
-    transferResponse:
+        skipPartyLookup:
+          description: >-
+            Set to true if supplying an FSPID for the payee party and no party
+            resolution is needed. This may be useful is a previous party
+            resolution has been performed.
+          type: boolean
+    errorTransferResponse:
+      allOf:
+        - $ref: '#/components/schemas/errorResponse'
+        - type: object
+          required:
+            - transferState
+          properties:
+            transferState:
+              $ref: '#/components/schemas/transferResponse'
+    requestToPayTransferRequest:
       type: object
       required:
-        - homeTransactionId
+        - requestToPayTransactionId
+        - from
+        - to
+        - amountType
+        - currency
+        - amount
+        - scenario
+        - initiator
+        - initiatorType
+      properties:
+        requestToPayTransactionId:
+          type: string
+          description: >-
+            Transaction ID from the DFSP backend, used to reconcile transactions
+            between the Switch and DFSP backend systems.
+        from:
+          $ref: '#/components/schemas/transferParty'
+        to:
+          $ref: '#/components/schemas/transferParty'
+        amountType:
+          $ref: '#/components/schemas/AmountType'
+        currency:
+          $ref: '#/components/schemas/Currency'
+        amount:
+          $ref: '#/components/schemas/Amount'
+        scenario:
+          $ref: '#/components/schemas/TransactionType'
+        initiator:
+          $ref: '#/components/schemas/TransactionInitiator'
+        initiatorType:
+          $ref: '#/components/schemas/TransactionInitiatorType'
+        note:
+          $ref: '#/components/schemas/Note'
+    requestToPayTransferResponse:
+      type: object
+      required:
+        - requestToPayTransactionId
         - from
         - to
         - amountType
@@ -2294,7 +2359,7 @@ components:
       properties:
         transferId:
           $ref: '#/components/schemas/CorrelationId'
-        homeTransactionId:
+        requestToPayTransactionId:
           type: string
           description: >-
             Transaction ID from the DFSP backend, used to reconcile transactions
@@ -2311,32 +2376,14 @@ components:
           $ref: '#/components/schemas/Amount'
         transactionType:
           $ref: '#/components/schemas/transferTransactionType'
-        subScenario:
-          $ref: '#/components/schemas/TransactionSubScenario'
         note:
           $ref: '#/components/schemas/Note'
         currentState:
           $ref: '#/components/schemas/transferStatus'
         quoteId:
           $ref: '#/components/schemas/CorrelationId'
-        getPartiesResponse:
-          type: object
-          required:
-            - body
-          properties:
-            body:
-              type: object
-            headers:
-              type: object
         quoteResponse:
-          type: object
-          required:
-            - body
-          properties:
-            body:
-              $ref: '#/components/schemas/QuotesIDPutResponse'
-            headers:
-              type: object
+          $ref: '#/components/schemas/QuotesIDPutResponse'
         quoteResponseSource:
           type: string
           description: >
@@ -2345,14 +2392,7 @@ components:
             account in the case of a FOREX transfer. i.e. it may be a FOREX
             gateway.
         fulfil:
-          type: object
-          required:
-            - body
-          properties:
-            body:
-              $ref: '#/components/schemas/TransfersIDPutResponse'
-            headers:
-              type: object
+          $ref: '#/components/schemas/TransfersIDPutResponse'
         lastError:
           description: >
             Object representing the last error to occur during a transfer
@@ -2360,21 +2400,6 @@ components:
             entity in the scheme or an object representing other types of error
             e.g. exceptions that may occur inside the scheme adapter.
           $ref: '#/components/schemas/transferError'
-        skipPartyLookup:
-          description: >-
-            Set to true if supplying an FSPID for the payee party and no party
-            resolution is needed. This may be useful is a previous party
-            resolution has been performed.
-          type: boolean
-    errorTransferResponse:
-      allOf:
-        - $ref: '#/components/schemas/errorResponse'
-        - type: object
-          required:
-            - transferState
-          properties:
-            transferState:
-              $ref: '#/components/schemas/transferResponse'
     transferContinuationAcceptOTP:
       type: object
       required:
@@ -2613,26 +2638,26 @@ components:
         application/json:
           schema:
             $ref: '#/components/schemas/requestToPayResponse'
-    requestToPayTransferSuccess:
-      description: Transfer completed successfully
+    transferServerError:
+      description: An error occurred processing the transfer
       content:
         application/json:
           schema:
-            $ref: '#/components/schemas/requestToPayTransferResponse'
-    requestToPayTransferBadRequest:
-      description: Malformed or missing required body, headers or parameters
+            $ref: '#/components/schemas/errorTransferResponse'
+    transferTimeout:
+      description: Timeout occurred processing the transfer
       content:
         application/json:
           schema:
             $ref: '#/components/schemas/errorTransferResponse'
-    transferServerError:
-      description: An error occurred processing the transfer
+    requestToPayTransferSuccess:
+      description: Transfer completed successfully
       content:
         application/json:
           schema:
-            $ref: '#/components/schemas/errorTransferResponse'
-    transferTimeout:
-      description: Timeout occurred processing the transfer
+            $ref: '#/components/schemas/requestToPayTransferResponse'
+    requestToPayTransferBadRequest:
+      description: Malformed or missing required body, headers or parameters
       content:
         application/json:
           schema:
@@ -2712,6 +2737,15 @@ components:
       description: >-
         A sub-identifier of the party identifier, or a sub-type of the party
         identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`.
+    requestToPayId:
+      name: requestToPayId
+      in: path
+      required: true
+      schema:
+        $ref: '#/components/schemas/CorrelationId'
+      description: >-
+        Identifier of the merchant request to pay to continue as returned in the
+        response to a `POST /requestToPay` request.
     requestToPayTransactionId:
       name: requestToPayTransactionId
       in: path

package/lib/sdk-scheme-adapter/v2_0_0/backend/json-schemas.json

@@ -8031,7 +8031,7 @@
                 "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$",
                 "type": "string"
             },
-            "transferAmount": {
+            "transactionRequestState": {
                 "enum": [
                     "RECEIVED",
                     "PENDING",

package/lib/sdk-scheme-adapter/v2_0_0/backend/openapi.d.ts

@@ -404,9 +404,7 @@ export interface components {
         /** @description A response to a request for a quote. */
         transactionRequestResponse: {
             transactionId: components["schemas"]["transactionId"];
-            transferAmount?: components["schemas"]["transactionRequestState"];
-        } & {
-            transactionRequestState: unknown;
+            transactionRequestState: components["schemas"]["transactionRequestState"];
         };
         /** @enum {string} */
         transactionRequestState: "RECEIVED" | "PENDING" | "ACCEPTED" | "REJECTED";

package/lib/sdk-scheme-adapter/v2_0_0/backend/schemas.d.ts

@@ -2599,7 +2599,7 @@ export declare namespace Schemas {
                 pattern: string;
                 type: string;
             };
-            transferAmount: {
+            transactionRequestState: {
                 enum: string[];
                 type: string;
             };