@mojaloop/api-snippets 14.2.0 → 14.2.1

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

@@ -978,7 +978,7 @@ paths:
                     type: boolean
         '400':
           description: Malformed or missing required body, headers or parameters
-          content: &ref_135
+          content: &ref_137
             application/json:
               schema:
                 allOf: &ref_14
@@ -1797,7 +1797,7 @@ paths:
         - name: bulkTransactionId
           in: path
           required: true
-          schema: &ref_151
+          schema: &ref_153
             title: CorrelationId
             type: string
             pattern: >-
@@ -1922,7 +1922,7 @@ paths:
           description: Bulk transaction information successfully amended
         '400':
           description: Malformed or missing required body, headers or parameters
-          content: &ref_136
+          content: &ref_138
             application/json:
               schema:
                 oneOf:
@@ -2154,7 +2154,7 @@ paths:
       responses:
         '200':
           description: Bulk transfer completed successfully
-          content: &ref_137
+          content: &ref_139
             application/json:
               schema:
                 type: object
@@ -2180,7 +2180,7 @@ paths:
         - name: bulkTransferId
           in: path
           required: true
-          schema: &ref_152
+          schema: &ref_154
             title: CorrelationId
             type: string
             pattern: >-
@@ -2413,7 +2413,7 @@ paths:
       responses:
         '200':
           description: Bulk quote completed successfully
-          content: &ref_138
+          content: &ref_140
             application/json:
               schema:
                 type: object
@@ -2535,7 +2535,7 @@ paths:
                       response.
         '400':
           description: Malformed or missing required body, headers or parameters
-          content: &ref_139
+          content: &ref_141
             application/json:
               schema:
                 allOf: &ref_47
@@ -2551,13 +2551,13 @@ paths:
                         properties: *ref_46
         '500':
           description: An error occurred processing the bulk quote
-          content: &ref_140
+          content: &ref_142
             application/json:
               schema:
                 allOf: *ref_47
         '504':
           description: Timeout occurred processing the bulk quote
-          content: &ref_141
+          content: &ref_143
             application/json:
               schema:
                 allOf: *ref_47
@@ -2575,7 +2575,7 @@ paths:
         - name: bulkQuoteId
           in: path
           required: true
-          schema: &ref_153
+          schema: &ref_155
             title: CorrelationId
             type: string
             pattern: >-
@@ -2761,7 +2761,7 @@ paths:
       responses:
         '200':
           description: Request to Pay completed successfully
-          content: &ref_142
+          content: &ref_144
             application/json:
               schema:
                 type: object
@@ -3064,7 +3064,7 @@ paths:
       responses:
         '200':
           description: Transfer completed successfully
-          content: &ref_143
+          content: &ref_145
             application/json:
               schema:
                 type: object
@@ -3202,7 +3202,7 @@ paths:
                     properties: *ref_26
         '400':
           description: Malformed or missing required body, headers or parameters
-          content: &ref_144
+          content: &ref_146
             application/json:
               schema:
                 allOf: *ref_14
@@ -3252,7 +3252,7 @@ paths:
         - name: requestToPayTransactionId
           in: path
           required: true
-          schema: &ref_154
+          schema: &ref_156
             title: CorrelationId
             type: string
             pattern: >-
@@ -3392,7 +3392,7 @@ paths:
       responses:
         '200':
           description: Accounts creation completed
-          content: &ref_145
+          content: &ref_147
             application/json:
               schema:
                 type: object
@@ -3547,7 +3547,7 @@ paths:
           content: *ref_55
         '504':
           description: Timeout occurred creating accounts
-          content: &ref_146
+          content: &ref_148
             application/json:
               schema:
                 allOf: *ref_56
@@ -3639,7 +3639,7 @@ paths:
       - name: SubId
         in: path
         required: true
-        schema: &ref_155
+        schema: &ref_157
           type: string
         description: >-
           A sub-identifier of the party identifier, or a sub-type of the party
@@ -3673,153 +3673,172 @@ paths:
         content:
           application/json:
             schema:
-              title: QuotesPostRequest
+              title: simpleQuotesPostRequest
               type: object
-              description: The object sent in the POST /quotes request.
-              properties: &ref_123
-                quoteId:
-                  title: CorrelationId
-                  type: string
-                  pattern: >-
-                    ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
-                  description: >-
-                    Identifier that correlates all messages of the same
-                    sequence. The API data type UUID (Universally Unique
-                    Identifier) is a JSON String in canonical format, conforming
-                    to [RFC 4122](https://tools.ietf.org/html/rfc4122), that is
-                    restricted by a regular expression for interoperability
-                    reasons. A UUID is always 36 characters long, 32 hexadecimal
-                    symbols and 4 dashes (‘-‘).
-                  example: b51ec534-ee48-4575-b6a9-ead2955b8069
-                transactionId:
-                  title: CorrelationId
-                  type: string
-                  pattern: >-
-                    ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
-                  description: >-
-                    Identifier that correlates all messages of the same
-                    sequence. The API data type UUID (Universally Unique
-                    Identifier) is a JSON String in canonical format, conforming
-                    to [RFC 4122](https://tools.ietf.org/html/rfc4122), that is
-                    restricted by a regular expression for interoperability
-                    reasons. A UUID is always 36 characters long, 32 hexadecimal
-                    symbols and 4 dashes (‘-‘).
-                  example: b51ec534-ee48-4575-b6a9-ead2955b8069
-                transactionRequestId:
-                  title: CorrelationId
+              properties: &ref_125
+                fspId:
+                  title: FspId
                   type: string
-                  pattern: >-
-                    ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
-                  description: >-
-                    Identifier that correlates all messages of the same
-                    sequence. The API data type UUID (Universally Unique
-                    Identifier) is a JSON String in canonical format, conforming
-                    to [RFC 4122](https://tools.ietf.org/html/rfc4122), that is
-                    restricted by a regular expression for interoperability
-                    reasons. A UUID is always 36 characters long, 32 hexadecimal
-                    symbols and 4 dashes (‘-‘).
-                  example: b51ec534-ee48-4575-b6a9-ead2955b8069
-                payee:
-                  title: Party
-                  type: object
-                  description: Data model for the complex type Party.
-                  properties: *ref_24
-                  required: *ref_25
-                payer:
-                  title: Party
+                  minLength: 1
+                  maxLength: 32
+                  description: FSP identifier.
+                quotesPostRequest:
+                  title: QuotesPostRequest
                   type: object
-                  description: Data model for the complex type Party.
-                  properties: *ref_24
-                  required: *ref_25
-                amountType:
-                  title: AmountType
-                  type: string
-                  enum: *ref_3
-                  description: >-
-                    Below are the allowed values for the enumeration AmountType.
+                  description: The object sent in the POST /quotes request.
+                  properties: &ref_123
+                    quoteId:
+                      title: CorrelationId
+                      type: string
+                      pattern: >-
+                        ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
+                      description: >-
+                        Identifier that correlates all messages of the same
+                        sequence. The API data type UUID (Universally Unique
+                        Identifier) is a JSON String in canonical format,
+                        conforming to [RFC
+                        4122](https://tools.ietf.org/html/rfc4122), that is
+                        restricted by a regular expression for interoperability
+                        reasons. A UUID is always 36 characters long, 32
+                        hexadecimal symbols and 4 dashes (‘-‘).
+                      example: b51ec534-ee48-4575-b6a9-ead2955b8069
+                    transactionId:
+                      title: CorrelationId
+                      type: string
+                      pattern: >-
+                        ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
+                      description: >-
+                        Identifier that correlates all messages of the same
+                        sequence. The API data type UUID (Universally Unique
+                        Identifier) is a JSON String in canonical format,
+                        conforming to [RFC
+                        4122](https://tools.ietf.org/html/rfc4122), that is
+                        restricted by a regular expression for interoperability
+                        reasons. A UUID is always 36 characters long, 32
+                        hexadecimal symbols and 4 dashes (‘-‘).
+                      example: b51ec534-ee48-4575-b6a9-ead2955b8069
+                    transactionRequestId:
+                      title: CorrelationId
+                      type: string
+                      pattern: >-
+                        ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
+                      description: >-
+                        Identifier that correlates all messages of the same
+                        sequence. The API data type UUID (Universally Unique
+                        Identifier) is a JSON String in canonical format,
+                        conforming to [RFC
+                        4122](https://tools.ietf.org/html/rfc4122), that is
+                        restricted by a regular expression for interoperability
+                        reasons. A UUID is always 36 characters long, 32
+                        hexadecimal symbols and 4 dashes (‘-‘).
+                      example: b51ec534-ee48-4575-b6a9-ead2955b8069
+                    payee:
+                      title: Party
+                      type: object
+                      description: Data model for the complex type Party.
+                      properties: *ref_24
+                      required: *ref_25
+                    payer:
+                      title: Party
+                      type: object
+                      description: Data model for the complex type Party.
+                      properties: *ref_24
+                      required: *ref_25
+                    amountType:
+                      title: AmountType
+                      type: string
+                      enum: *ref_3
+                      description: >-
+                        Below are the allowed values for the enumeration
+                        AmountType.
 
-                    - SEND - Amount the Payer would like to send, that is, the
-                    amount that should be withdrawn from the Payer account
-                    including any fees.
+                        - SEND - Amount the Payer would like to send, that is,
+                        the amount that should be withdrawn from the Payer
+                        account including any fees.
 
-                    - RECEIVE - Amount the Payer would like the Payee to
-                    receive, that is, the amount that should be sent to the
-                    receiver exclusive of any fees.
-                  example: RECEIVE
-                amount:
-                  title: Money
-                  type: object
-                  description: Data model for the complex type Money.
-                  properties: *ref_6
-                  required: *ref_7
-                fees:
-                  title: Money
-                  type: object
-                  description: Data model for the complex type Money.
-                  properties: *ref_6
-                  required: *ref_7
-                transactionType:
-                  type: string
-                  enum: *ref_5
-                  description: Type of transaction.
-                geoCode:
-                  title: GeoCode
-                  type: object
-                  description: >-
-                    Data model for the complex type GeoCode. Indicates the
-                    geographic location from where the transaction was
-                    initiated.
-                  properties: *ref_63
-                  required: *ref_64
-                note:
-                  title: Note
-                  type: string
-                  minLength: 1
-                  maxLength: 128
-                  description: Memo assigned to transaction.
-                  example: Note sent to Payee.
-                expiration:
-                  title: DateTime
-                  type: string
-                  pattern: >-
-                    ^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:(\.\d{3}))(?:Z|[+-][01]\d:[0-5]\d)$
-                  description: >-
-                    The API data type DateTime is a JSON String in a lexical
-                    format that is restricted by a regular expression for
-                    interoperability reasons. The format is according to [ISO
-                    8601](https://www.iso.org/iso-8601-date-and-time-format.html),
-                    expressed in a combined date, time and time zone format. A
-                    more readable version of the format is
-                    yyyy-MM-ddTHH:mm:ss.SSS[-HH:MM]. Examples are
-                    "2016-05-24T08:38:08.699-04:00", "2016-05-24T08:38:08.699Z"
-                    (where Z indicates Zulu time zone, same as UTC).
-                  example: '2016-05-24T08:38:08.699-04:00'
-                extensionList:
-                  title: ExtensionList
-                  type: object
-                  description: >-
-                    Data model for the complex type ExtensionList. An optional
-                    list of extensions, specific to deployment.
-                  properties: *ref_10
-                  required: *ref_11
-              required: &ref_124
-                - quoteId
-                - transactionId
-                - payee
-                - payer
-                - amountType
-                - amount
-                - transactionType
+                        - RECEIVE - Amount the Payer would like the Payee to
+                        receive, that is, the amount that should be sent to the
+                        receiver exclusive of any fees.
+                      example: RECEIVE
+                    amount:
+                      title: Money
+                      type: object
+                      description: Data model for the complex type Money.
+                      properties: *ref_6
+                      required: *ref_7
+                    fees:
+                      title: Money
+                      type: object
+                      description: Data model for the complex type Money.
+                      properties: *ref_6
+                      required: *ref_7
+                    transactionType:
+                      type: string
+                      enum: *ref_5
+                      description: Type of transaction.
+                    geoCode:
+                      title: GeoCode
+                      type: object
+                      description: >-
+                        Data model for the complex type GeoCode. Indicates the
+                        geographic location from where the transaction was
+                        initiated.
+                      properties: *ref_63
+                      required: *ref_64
+                    note:
+                      title: Note
+                      type: string
+                      minLength: 1
+                      maxLength: 128
+                      description: Memo assigned to transaction.
+                      example: Note sent to Payee.
+                    expiration:
+                      title: DateTime
+                      type: string
+                      pattern: >-
+                        ^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:(\.\d{3}))(?:Z|[+-][01]\d:[0-5]\d)$
+                      description: >-
+                        The API data type DateTime is a JSON String in a lexical
+                        format that is restricted by a regular expression for
+                        interoperability reasons. The format is according to
+                        [ISO
+                        8601](https://www.iso.org/iso-8601-date-and-time-format.html),
+                        expressed in a combined date, time and time zone format.
+                        A more readable version of the format is
+                        yyyy-MM-ddTHH:mm:ss.SSS[-HH:MM]. Examples are
+                        "2016-05-24T08:38:08.699-04:00",
+                        "2016-05-24T08:38:08.699Z" (where Z indicates Zulu time
+                        zone, same as UTC).
+                      example: '2016-05-24T08:38:08.699-04:00'
+                    extensionList:
+                      title: ExtensionList
+                      type: object
+                      description: >-
+                        Data model for the complex type ExtensionList. An
+                        optional list of extensions, specific to deployment.
+                      properties: *ref_10
+                      required: *ref_11
+                  required: &ref_124
+                    - quoteId
+                    - transactionId
+                    - payee
+                    - payer
+                    - amountType
+                    - amount
+                    - transactionType
+              required: &ref_126
+                - fspId
+                - quotesPostRequest
         required: true
       responses:
         '200':
           description: sync response from POST /quotes
-          content: &ref_147
+          content: &ref_149
             application/json:
               schema:
                 title: QuotesPostResponse
                 type: object
-                properties: &ref_125
+                properties: &ref_127
                   quotes:
                     title: QuotesIDPutResponse
                     type: object
@@ -3909,15 +3928,15 @@ paths:
                   currentState:
                     type: string
                     enum: *ref_65
-                required: &ref_126
+                required: &ref_128
                   - quotes
                   - currentState
         '500':
           description: An error occurred processing the quotes request
-          content: &ref_148
+          content: &ref_150
             application/json:
               schema:
-                allOf: &ref_127
+                allOf: &ref_129
                   - type: object
                     properties: *ref_22
                   - type: object
@@ -3935,7 +3954,7 @@ paths:
             schema:
               title: SimpleTransfersPostRequest
               type: object
-              properties: &ref_130
+              properties: &ref_132
                 fspId:
                   title: FspId
                   type: string
@@ -3946,7 +3965,7 @@ paths:
                   title: TransfersPostRequest
                   type: object
                   description: The object sent in the POST /transfers request.
-                  properties: &ref_128
+                  properties: &ref_130
                     transferId:
                       title: CorrelationId
                       type: string
@@ -4023,7 +4042,7 @@ paths:
                         optional list of extensions, specific to deployment.
                       properties: *ref_10
                       required: *ref_11
-                  required: &ref_129
+                  required: &ref_131
                     - transferId
                     - payeeFsp
                     - payerFsp
@@ -4031,19 +4050,19 @@ paths:
                     - ilpPacket
                     - condition
                     - expiration
-              required: &ref_131
+              required: &ref_133
                 - fspId
                 - transfersPostRequest
         required: true
       responses:
         '200':
           description: sync response from POST /simpleTransfers
-          content: &ref_149
+          content: &ref_151
             application/json:
               schema:
                 title: SimpleTransfersPostResponse
                 type: object
-                properties: &ref_132
+                properties: &ref_134
                   transfer:
                     properties:
                       body:
@@ -4060,15 +4079,15 @@ paths:
                   currentState:
                     type: string
                     enum: *ref_65
-                required: &ref_133
+                required: &ref_135
                   - transfer
                   - currentState
         '500':
           description: An error occurred processing the simple transfers request
-          content: &ref_150
+          content: &ref_152
             application/json:
               schema:
-                allOf: &ref_134
+                allOf: &ref_136
                   - type: object
                     properties: *ref_22
                   - type: object
@@ -4711,38 +4730,43 @@ components:
       description: The object sent in the POST /quotes request.
       properties: *ref_123
       required: *ref_124
-    quotesPostResponse:
-      title: QuotesPostResponse
+    simpleQuotesPostRequest:
+      title: simpleQuotesPostRequest
       type: object
       properties: *ref_125
       required: *ref_126
+    quotesPostResponse:
+      title: QuotesPostResponse
+      type: object
+      properties: *ref_127
+      required: *ref_128
     errorQuotesResponse:
-      allOf: *ref_127
+      allOf: *ref_129
     TransfersPostRequest:
       title: TransfersPostRequest
       type: object
       description: The object sent in the POST /transfers request.
-      properties: *ref_128
-      required: *ref_129
+      properties: *ref_130
+      required: *ref_131
     simpleTransfersPostRequest:
       title: SimpleTransfersPostRequest
       type: object
-      properties: *ref_130
-      required: *ref_131
+      properties: *ref_132
+      required: *ref_133
     simpleTransfersPostResponse:
       title: SimpleTransfersPostResponse
       type: object
-      properties: *ref_132
-      required: *ref_133
+      properties: *ref_134
+      required: *ref_135
     errorSimpleTransfersResponse:
-      allOf: *ref_134
+      allOf: *ref_136
   responses:
     transferSuccess:
       description: Transfer completed successfully
       content: *ref_15
     transferBadRequest:
       description: Malformed or missing required body, headers or parameters
-      content: *ref_135
+      content: *ref_137
     transferServerError:
       description: An error occurred processing the transfer
       content: *ref_16
@@ -4759,40 +4783,40 @@ components:
       content: *ref_43
     bulkTransactionPutBadRequest:
       description: Malformed or missing required body, headers or parameters
-      content: *ref_136
+      content: *ref_138
     bulkTransferSuccess:
       description: Bulk transfer completed successfully
-      content: *ref_137
+      content: *ref_139
     bulkQuoteSuccess:
       description: Bulk quote completed successfully
-      content: *ref_138
+      content: *ref_140
     bulkQuoteBadRequest:
       description: Malformed or missing required body, headers or parameters
-      content: *ref_139
+      content: *ref_141
     bulkQuoteServerError:
       description: An error occurred processing the bulk quote
-      content: *ref_140
+      content: *ref_142
     bulkQuoteTimeout:
       description: Timeout occurred processing the bulk quote
-      content: *ref_141
+      content: *ref_143
     requestToPaySuccess:
       description: Request to Pay completed successfully
-      content: *ref_142
+      content: *ref_144
     requestToPayTransferSuccess:
       description: Transfer completed successfully
-      content: *ref_143
+      content: *ref_145
     requestToPayTransferBadRequest:
       description: Malformed or missing required body, headers or parameters
-      content: *ref_144
+      content: *ref_146
     accountsCreationCompleted:
       description: Accounts creation completed
-      content: *ref_145
+      content: *ref_147
     accountsCreationError:
       description: An error occurred creating accounts
       content: *ref_55
     accountsCreationTimeout:
       description: Timeout occurred creating accounts
-      content: *ref_146
+      content: *ref_148
     partiesByIdSuccess:
       description: PartiesByIdSuccess
       content: *ref_61
@@ -4801,16 +4825,16 @@ components:
       content: *ref_62
     quotesPostSuccess:
       description: sync response from POST /quotes
-      content: *ref_147
+      content: *ref_149
     quotesServerError:
       description: An error occurred processing the quotes request
-      content: *ref_148
+      content: *ref_150
     simpleTransfersPostSuccess:
       description: sync response from POST /simpleTransfers
-      content: *ref_149
+      content: *ref_151
     simpleTransfersServerError:
       description: An error occurred processing the simple transfers request
-      content: *ref_150
+      content: *ref_152
   parameters:
     transferId:
       name: transferId
@@ -4824,7 +4848,7 @@ components:
       name: bulkTransactionId
       in: path
       required: true
-      schema: *ref_151
+      schema: *ref_153
       description: >-
         Identifier of the bulk transaction to continue as returned in the
         response to a `POST /bulkTransaction` request.
@@ -4832,7 +4856,7 @@ components:
       name: bulkTransferId
       in: path
       required: true
-      schema: *ref_152
+      schema: *ref_154
       description: >-
         Identifier of the bulk transfer to continue as returned in the response
         to a `POST /bulkTransfers` request.
@@ -4840,7 +4864,7 @@ components:
       name: bulkQuoteId
       in: path
       required: true
-      schema: *ref_153
+      schema: *ref_155
       description: >-
         Identifier of the bulk transfer to continue as returned in the response
         to a `POST /bulkTransfers` request.
@@ -4848,7 +4872,7 @@ components:
       name: requestToPayTransactionId
       in: path
       required: true
-      schema: *ref_154
+      schema: *ref_156
       description: >-
         Identifier of the merchant request to pay transfer to continue as
         returned in the response to a `POST /requestToPayTransfer` request.
@@ -4868,7 +4892,7 @@ components:
       name: SubId
       in: path
       required: true
-      schema: *ref_155
+      schema: *ref_157
       description: >-
         A sub-identifier of the party identifier, or a sub-type of the party
         identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`.