@mojaloop/api-snippets 17.0.0 → 17.0.2-snapshot.0

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

@@ -0,0 +1,2744 @@
+openapi: 3.0.1
+info:
+  title: Mojaloop SDK Backend API
+  description: >
+    API specification for the SDK Backend API.
+
+
+    To be implemented by the Digital Financial Service Provider (DFSP) to work
+    in tandem with the Mojaloop SDK (`mojaloop/sdk-scheme-adapter`).
+
+
+    This API is not to be confused with the Mojaloop SDK's Inbound or Outbound
+    API.
+
+
+    TODO: More explanation and links about the SDK adapter's Inbound and
+    Outbound API.
+
+
+    **Note on terminology:** The term "Switch" is equal to the term "Hub", and
+    the term "FSP" is equal to the term "DFSP".
+  license:
+    name: Apache License Version 2.0, January 2004
+    url: http://www.apache.org/licenses/
+  version: 1.1.0
+paths:
+  /:
+    get:
+      operationId: BackendHealthCheck
+      responses:
+        '200':
+          description: Returns empty body if the service is running.
+      summary: Health check endpoint.
+  /bulkQuotes:
+    post:
+      operationId: BackendBulkQuotesPost
+      requestBody:
+        content:
+          application/json:
+            schema:
+              description: A request for a bulk quote.
+              properties: &ref_53
+                bulkQuoteId:
+                  description: A Mojaloop API bulk quote identifier (UUID).
+                  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
+                expiration:
+                  description: An ISO-8601 formatted timestamp.
+                  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)$
+                  type: string
+                from:
+                  properties: &ref_1
+                    dateOfBirth:
+                      description: Date of birth in the form YYYY-MM-DD.
+                      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)$
+                      type: string
+                    displayName:
+                      description: Display name of the sender, if known.
+                      type: string
+                    extensionList:
+                      items: &ref_12
+                        properties: &ref_29
+                          key:
+                            maxLength: 32
+                            minLength: 1
+                            type: string
+                          value:
+                            maxLength: 128
+                            minLength: 1
+                            type: string
+                        type: object
+                      maxItems: 16
+                      minItems: 0
+                      type: array
+                    firstName:
+                      description: Party first name.
+                      type: string
+                    fspId:
+                      description: >-
+                        Mojaloop scheme FSPID of the DFSP which owns the party
+                        account.
+                      type: string
+                    idSubValue:
+                      maxLength: 128
+                      minLength: 1
+                      type: string
+                    idType:
+                      enum: &ref_21
+                        - MSISDN
+                        - ACCOUNT_NO
+                        - EMAIL
+                        - PERSONAL_ID
+                        - BUSINESS
+                        - DEVICE
+                        - ACCOUNT_ID
+                        - IBAN
+                        - ALIAS
+                      type: string
+                    idValue:
+                      description: The identifier string used to identify the sender.
+                      type: string
+                    lastName:
+                      description: Party last name.
+                      type: string
+                    merchantClassificationCode:
+                      description: >-
+                        Up to 4 digits specifying the sender's merchant
+                        classification, if known and applicable.
+                      type: string
+                    middleName:
+                      description: Party middle name.
+                      type: string
+                    type:
+                      enum: &ref_22
+                        - CONSUMER
+                        - AGENT
+                        - BUSINESS
+                        - DEVICE
+                      type: string
+                  required: &ref_2
+                    - idType
+                    - idValue
+                  type: object
+                geoCode:
+                  description: >-
+                    Indicates the geographic location from where the transaction
+                    was initiated.
+                  properties: &ref_19
+                    latitude:
+                      description: >-
+                        The API data type Latitude is a JSON String in a lexical
+                        format that is restricted by a regular expression for
+                        interoperability reasons.
+                      pattern: >-
+                        ^(\+|-)?(?:90(?:(?:\.0{1,6})?)|(?:[0-9]|[1-8][0-9])(?:(?:\.[0-9]{1,6})?))$
+                      type: string
+                    longitude:
+                      description: >-
+                        The API data type Longitude is a JSON String in a
+                        lexical format that is restricted by a regular
+                        expression for interoperability reasons.
+                      pattern: >-
+                        ^(\+|-)?(?:180(?:(?:\.0{1,6})?)|(?:[0-9]|[1-9][0-9]|1[0-7][0-9])(?:(?:\.[0-9]{1,6})?))$
+                      type: string
+                  required: &ref_20
+                    - latitude
+                    - longitude
+                  type: object
+                individualQuotes:
+                  items:
+                    description: Data model for individual quote in a bulk quote request.
+                    properties: &ref_36
+                      amount:
+                        pattern: ^([0]|([1-9][0-9]{0,17}))([.][0-9]{0,3}[1-9])?$
+                        type: string
+                      amountType:
+                        enum: &ref_8
+                          - SEND
+                          - RECEIVE
+                        type: string
+                      currency:
+                        enum: &ref_0
+                          - AED
+                          - AFN
+                          - ALL
+                          - AMD
+                          - ANG
+                          - AOA
+                          - ARS
+                          - AUD
+                          - AWG
+                          - AZN
+                          - BAM
+                          - BBD
+                          - BDT
+                          - BGN
+                          - BHD
+                          - BIF
+                          - BMD
+                          - BND
+                          - BOB
+                          - BRL
+                          - BSD
+                          - BTN
+                          - BWP
+                          - BYN
+                          - BZD
+                          - CAD
+                          - CDF
+                          - CHF
+                          - CLP
+                          - CNY
+                          - COP
+                          - CRC
+                          - CUC
+                          - CUP
+                          - CVE
+                          - CZK
+                          - DJF
+                          - DKK
+                          - DOP
+                          - DZD
+                          - EGP
+                          - ERN
+                          - ETB
+                          - EUR
+                          - FJD
+                          - FKP
+                          - GBP
+                          - GEL
+                          - GGP
+                          - GHS
+                          - GIP
+                          - GMD
+                          - GNF
+                          - GTQ
+                          - GYD
+                          - HKD
+                          - HNL
+                          - HRK
+                          - HTG
+                          - HUF
+                          - IDR
+                          - ILS
+                          - IMP
+                          - INR
+                          - IQD
+                          - IRR
+                          - ISK
+                          - JEP
+                          - JMD
+                          - JOD
+                          - JPY
+                          - KES
+                          - KGS
+                          - KHR
+                          - KMF
+                          - KPW
+                          - KRW
+                          - KWD
+                          - KYD
+                          - KZT
+                          - LAK
+                          - LBP
+                          - LKR
+                          - LRD
+                          - LSL
+                          - LYD
+                          - MAD
+                          - MDL
+                          - MGA
+                          - MKD
+                          - MMK
+                          - MNT
+                          - MOP
+                          - MRO
+                          - MUR
+                          - MVR
+                          - MWK
+                          - MXN
+                          - MYR
+                          - MZN
+                          - NAD
+                          - NGN
+                          - NIO
+                          - NOK
+                          - NPR
+                          - NZD
+                          - OMR
+                          - PAB
+                          - PEN
+                          - PGK
+                          - PHP
+                          - PKR
+                          - PLN
+                          - PYG
+                          - QAR
+                          - RON
+                          - RSD
+                          - RUB
+                          - RWF
+                          - SAR
+                          - SBD
+                          - SCR
+                          - SDG
+                          - SEK
+                          - SGD
+                          - SHP
+                          - SLL
+                          - SOS
+                          - SPL
+                          - SRD
+                          - STD
+                          - SVC
+                          - SYP
+                          - SZL
+                          - THB
+                          - TJS
+                          - TMT
+                          - TND
+                          - TOP
+                          - TRY
+                          - TTD
+                          - TVD
+                          - TWD
+                          - TZS
+                          - UAH
+                          - UGX
+                          - USD
+                          - UYU
+                          - UZS
+                          - VEF
+                          - VND
+                          - VUV
+                          - WST
+                          - XAF
+                          - XCD
+                          - XDR
+                          - XOF
+                          - XPF
+                          - XTS
+                          - XXX
+                          - YER
+                          - ZAR
+                          - ZMW
+                          - ZWD
+                        maxLength: 3
+                        minLength: 3
+                        type: string
+                      feesAmount:
+                        pattern: ^([0]|([1-9][0-9]{0,17}))([.][0-9]{0,3}[1-9])?$
+                        type: string
+                      feesCurrency:
+                        enum: *ref_0
+                        maxLength: 3
+                        minLength: 3
+                        type: string
+                      initiator:
+                        enum: &ref_9
+                          - PAYER
+                          - PAYEE
+                        type: string
+                      initiatorType:
+                        enum: &ref_10
+                          - CONSUMER
+                          - AGENT
+                          - BUSINESS
+                          - DEVICE
+                        type: string
+                      note:
+                        description: An optional note associated with the quote.
+                        maxLength: 128
+                        minLength: 1
+                        type: string
+                      quoteId:
+                        description: A Mojaloop API quote identifier (UUID).
+                        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
+                      subScenario:
+                        description: >-
+                          Possible sub-scenario, defined locally within the
+                          scheme (UndefinedEnum Type). Based on FSPIOP
+                          TransactionSubScenario.
+                        example: LOCALLY_DEFINED_SUBSCENARIO
+                        pattern: ^[A-Z_]{1,32}$
+                        title: transactionSubScenario
+                        type: string
+                      to:
+                        properties: *ref_1
+                        required: *ref_2
+                        type: object
+                      transactionId:
+                        description: >-
+                          ID of the transaction, the ID is decided by the Payer
+                          FSP during the creation of the quote.
+                        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
+                      transactionType:
+                        enum: &ref_11
+                          - TRANSFER
+                          - DEPOSIT
+                          - PAYMENT
+                        type: string
+                    required: &ref_37
+                      - quoteId
+                      - transactionId
+                      - to
+                      - amountType
+                      - amount
+                      - currency
+                      - transactionType
+                      - initiator
+                      - initiatorType
+                    type: object
+                  maxItems: 1000
+                  minItems: 1
+                  type: array
+              required: &ref_54
+                - bulkQuoteId
+                - from
+                - individualQuotes
+              type: object
+        description: Incoming request for a bulk quotation.
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                description: A response to a request for a bulk quote.
+                properties: &ref_4
+                  bulkQuoteId:
+                    description: A Mojaloop API bulk quote identifier (UUID).
+                    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
+                  expiration:
+                    description: An ISO-8601 formatted timestamp.
+                    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)$
+                    type: string
+                  individualQuoteResults:
+                    description: >-
+                      Fees for each individual transaction, if any of them are
+                      charged per transaction.
+                    items:
+                      oneOf:
+                        - description: >-
+                            Data model for successful individual quote in a bulk
+                            quote response.
+                          properties: &ref_40
+                            payeeFspCommissionAmount:
+                              pattern: ^([0]|([1-9][0-9]{0,17}))([.][0-9]{0,3}[1-9])?$
+                              type: string
+                            payeeFspCommissionAmountCurrency:
+                              enum: *ref_0
+                              maxLength: 3
+                              minLength: 3
+                              type: string
+                            payeeFspFeeAmount:
+                              pattern: ^([0]|([1-9][0-9]{0,17}))([.][0-9]{0,3}[1-9])?$
+                              type: string
+                            payeeFspFeeAmountCurrency:
+                              enum: *ref_0
+                              maxLength: 3
+                              minLength: 3
+                              type: string
+                            payeeReceiveAmount:
+                              pattern: ^([0]|([1-9][0-9]{0,17}))([.][0-9]{0,3}[1-9])?$
+                              type: string
+                            payeeReceiveAmountCurrency:
+                              enum: *ref_0
+                              maxLength: 3
+                              minLength: 3
+                              type: string
+                            quoteId:
+                              description: A Mojaloop API quote identifier (UUID).
+                              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:
+                              pattern: ^([0]|([1-9][0-9]{0,17}))([.][0-9]{0,3}[1-9])?$
+                              type: string
+                            transferAmountCurrency:
+                              enum: *ref_0
+                              maxLength: 3
+                              minLength: 3
+                              type: string
+                          required: &ref_41
+                            - quoteId
+                          type: object
+                        - description: >-
+                            Data model for failed individual quote in a bulk
+                            quote response.
+                          properties: &ref_38
+                            errorResponse:
+                              properties: &ref_3
+                                message:
+                                  description: Error message text
+                                  type: string
+                                statusCode:
+                                  description: >
+                                    Backend error code from FSP. Ideally,
+                                    statusCode is FSPIOP conforming. SDK will
+                                    use status code to retrieve an FSPIOP error
+                                    with the same code.
+
+                                    Otherwise, a suitable generic FSPIOP will be
+                                    used with the errorResponse in the FSPIOP
+                                    error message.
+                                  type: string
+                              type: object
+                            quoteId:
+                              description: A Mojaloop API quote identifier (UUID).
+                              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
+                          required: &ref_39
+                            - quoteId
+                            - errorResponse
+                          type: object
+                    maxItems: 1000
+                    minItems: 1
+                    type: array
+                required: &ref_5
+                  - bulkQuoteId
+                  - individualQuoteResults
+                type: object
+          description: A response to the bulk quote request.
+        '400':
+          content: &ref_6
+            application/json:
+              schema:
+                properties: *ref_3
+                type: object
+          description: Malformed or missing required headers or parameters.
+        '500':
+          content: &ref_7
+            application/json:
+              schema:
+                properties: *ref_3
+                type: object
+          description: An error occurred processing the request.
+      summary: Requests a bulk quote.
+      tags:
+        - BulkQuotes
+  /bulkQuotes/{idValue}:
+    get:
+      operationId: BackendBulkQuotesGet
+      parameters:
+        - description: The identifier value.
+          in: path
+          name: idValue
+          required: true
+          schema: &ref_13
+            type: string
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                description: A response to a request for a bulk quote.
+                properties: *ref_4
+                required: *ref_5
+                type: object
+          description: Response containing details of the requested bulk quote.
+        '400':
+          content: *ref_6
+          description: Malformed or missing required headers or parameters.
+        '404':
+          description: >-
+            The party specified by the provided identifier type and value is not
+            known to the server.
+        '500':
+          content: *ref_7
+          description: An error occurred processing the request.
+      summary: >-
+        Requests information relating to a bulk quote identified by the
+        specified identifier value.
+      tags:
+        - BulkQuotes
+  /bulkTransactions/{bulkTransactionId}:
+    put:
+      description: >-
+        The HTTP request `PUT /bulkTransactions/{bulkTransactionId}` is used to
+        amend information regarding a bulk transaction, i.e. when
+        autoAcceptParty or autoAcceptQuote  is false then the payer need to
+        provide confirmation to proceed with further processing of the request.
+        The `{bulkTransactionId}` in the URI should contain the
+        `bulkTransactionId` that was used for the creation of the bulk transfer.
+      operationId: BackendBulkTransactionsPut
+      parameters:
+        - description: Identifier of the bulk transaction to continue as returned in.
+          in: path
+          name: bulkTransactionId
+          required: true
+          schema: &ref_30
+            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
+            pattern: >-
+              ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
+            title: CorrelationId
+            type: string
+      requestBody:
+        content:
+          application/json:
+            schema:
+              properties:
+                bulkHomeTransactionID:
+                  description: >-
+                    Transaction ID from the DFSP backend, used to reconcile
+                    transactions between the Switch and DFSP backend systems.
+                  type: string
+                individualTransferResults:
+                  description: >-
+                    List of individual transfers in a bulk transfer with accept
+                    party information.
+                  items:
+                    description: >-
+                      Data model for the 'individualTransfer' while accepting
+                      party or quote.
+                    properties:
+                      homeTransactionId:
+                        description: >-
+                          Transaction ID from the DFSP backend, used to
+                          reconcile transactions between the Switch and DFSP
+                          backend systems.
+                        type: string
+                      transactionId:
+                        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
+                        pattern: >-
+                          ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
+                        title: CorrelationId
+                        type: string
+                    required:
+                      - homeTransactionId
+                    type: object
+                  minItems: 1
+                  type: array
+              required:
+                - bulkHomeTransactionID
+                - individualTransferResults
+              type: object
+        description: Bulk transaction request body.
+        required: true
+      responses:
+        '202':
+          description: Bulk transaction information successfully amended.
+        '400':
+          content: *ref_6
+          description: Malformed or missing required headers or parameters.
+        '500':
+          content: *ref_7
+          description: An error occurred processing the request.
+      summary: Callbacks for the bulk transaction request.
+      tags:
+        - BulkTransactionsPut
+  /bulkTransfers:
+    post:
+      operationId: BackendBulkTransfersPost
+      requestBody:
+        content:
+          application/json:
+            schema:
+              properties: &ref_55
+                bulkQuote:
+                  description: A response to a request for a bulk quote.
+                  properties: *ref_4
+                  required: *ref_5
+                  type: object
+                bulkTransferId:
+                  description: A Mojaloop API transfer identifier (UUID).
+                  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
+                from:
+                  properties: *ref_1
+                  required: *ref_2
+                  type: object
+                individualTransfers:
+                  items:
+                    description: >-
+                      Data model for individual transfer in a bulk transfer
+                      request.
+                    properties: &ref_42
+                      amount:
+                        pattern: ^([0]|([1-9][0-9]{0,17}))([.][0-9]{0,3}[1-9])?$
+                        type: string
+                      amountType:
+                        enum: *ref_8
+                        type: string
+                      currency:
+                        enum: *ref_0
+                        maxLength: 3
+                        minLength: 3
+                        type: string
+                      feesAmount:
+                        pattern: ^([0]|([1-9][0-9]{0,17}))([.][0-9]{0,3}[1-9])?$
+                        type: string
+                      feesCurrency:
+                        enum: *ref_0
+                        maxLength: 3
+                        minLength: 3
+                        type: string
+                      initiator:
+                        enum: *ref_9
+                        type: string
+                      initiatorType:
+                        enum: *ref_10
+                        type: string
+                      note:
+                        description: An optional note associated with the quote.
+                        maxLength: 128
+                        minLength: 1
+                        type: string
+                      subScenario:
+                        description: >-
+                          Possible sub-scenario, defined locally within the
+                          scheme (UndefinedEnum Type). Based on FSPIOP
+                          TransactionSubScenario.
+                        example: LOCALLY_DEFINED_SUBSCENARIO
+                        pattern: ^[A-Z_]{1,32}$
+                        title: transactionSubScenario
+                        type: string
+                      to:
+                        properties: *ref_1
+                        required: *ref_2
+                        type: object
+                      transactionType:
+                        enum: *ref_11
+                        type: string
+                      transferId:
+                        description: A Mojaloop API transfer identifier (UUID).
+                        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
+                    required: &ref_43
+                      - transferId
+                      - amount
+                      - currency
+                    type: object
+                  maxItems: 1000
+                  minItems: 1
+                  type: array
+              required: &ref_56
+                - bulkTransferId
+                - individualTransfers
+              type: object
+        description: An incoming bulk transfer request.
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                properties: &ref_14
+                  bulkTransferId:
+                    description: A Mojaloop API transfer identifier (UUID).
+                    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
+                  homeTransactionId:
+                    description: >-
+                      Transaction ID from the DFSP backend, used to reconcile
+                      transactions between the switch and DFSP backend systems.
+                    type: string
+                  individualTransferResults:
+                    items:
+                      description: >-
+                        Data model for individual transfer in a bulk transfer
+                        response.
+                      properties: &ref_44
+                        errorResponse:
+                          properties: *ref_3
+                          type: object
+                        extensionList:
+                          items: *ref_12
+                          maxItems: 16
+                          minItems: 0
+                          type: array
+                        transferId:
+                          description: A Mojaloop API transfer identifier (UUID).
+                          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
+                      required: &ref_45
+                        - transferId
+                      type: object
+                    maxItems: 1000
+                    minItems: 1
+                    type: array
+                required: &ref_15
+                  - homeTransactionId
+                type: object
+          description: The bulk transfer was accepted.
+        '400':
+          content: *ref_6
+          description: Malformed or missing required headers or parameters.
+        '500':
+          content: *ref_7
+          description: An error occurred processing the request.
+      summary: >-
+        Execute bulk transfer of funds from an external account to internal
+        accounts.
+      tags:
+        - BulkTransfers
+  /bulkTransfers/{idValue}:
+    get:
+      operationId: BackendBulkTransfersGet
+      parameters:
+        - description: The identifier value.
+          in: path
+          name: idValue
+          required: true
+          schema: *ref_13
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                properties: *ref_14
+                required: *ref_15
+                type: object
+          description: Response containing details of the requested bulk transfer.
+        '400':
+          content: *ref_6
+          description: Malformed or missing required headers or parameters.
+        '404':
+          description: >-
+            The party specified by the provided identifier type and value is not
+            known to the server.
+        '500':
+          content: *ref_7
+          description: An error occurred processing the request.
+      summary: >-
+        Requests information relating to a bulk transfer identified by the
+        specified identifier value.
+      tags:
+        - BulkTransfers
+  /otp/{requestToPayId}:
+    get:
+      operationId: BackendOtpGet
+      parameters:
+        - in: path
+          name: requestToPayId
+          required: true
+          schema: &ref_31
+            maxLength: 128
+            minLength: 1
+            type: string
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                properties: &ref_65
+                  otpValue:
+                    description: OTP value.
+                    type: string
+                required: &ref_66
+                  - otpValue
+                type: object
+          description: Response containing details of the OTP.
+        '400':
+          content: *ref_6
+          description: Malformed or missing required headers or parameters.
+        '404':
+          description: >-
+            The party specified by the provided identifier type and value is not
+            known to the server.
+        '500':
+          content: *ref_7
+          description: An error occurred processing the request.
+      summary: Requests OTP.
+      tags:
+        - OTP
+  /participants/{idType}/{idValue}:
+    get:
+      description: >-
+        The HTTP request `GET /participants/{idType}/{idValue}` is used to find
+        out in which FSP the requested party, defined by `{idType}` and
+        `{idValue}`, is located.
+      operationId: BackendParticipantsGetByTypeAndID
+      parameters:
+        - description: >-
+            The type of the party identifier. For example, `MSISDN`,
+            `PERSONAL_ID`.
+          in: path
+          name: idType
+          required: true
+          schema: &ref_16
+            type: string
+        - description: The identifier value.
+          in: path
+          name: idValue
+          required: true
+          schema: *ref_13
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                properties: &ref_17
+                  fspId:
+                    description: FSP identifier.
+                    maxLength: 32
+                    minLength: 1
+                    type: string
+                type: object
+          description: Response containing details of the requested party.
+        '400':
+          content: *ref_6
+          description: Malformed or missing required headers or parameters.
+        '404':
+          description: >-
+            The party specified by the provided identifier type and value is not
+            known to the server.
+        '500':
+          content: *ref_7
+          description: An error occurred processing the request.
+      summary: >-
+        Asks for the identifier (fspId) of the scheme participant (FSP) that can
+        handle transfers for the specified identifier type and value.
+      tags:
+        - Participants
+  /participants/{idType}/{idValue}/{idSubValue}:
+    get:
+      description: >-
+        The HTTP request `GET /participants/{idType}/{idValue}/{idSubValue}` is
+        used to find out in which FSP the requested party, defined by
+        `{idType}`, `{idValue}` and `{idSubValue}` is located.
+      operationId: BackendParticipantsGetByTypeIDAndSubId
+      parameters:
+        - description: >-
+            The type of the party identifier. For example, `MSISDN`,
+            `PERSONAL_ID`.
+          in: path
+          name: idType
+          required: true
+          schema: *ref_16
+        - description: The identifier value.
+          in: path
+          name: idValue
+          required: true
+          schema: *ref_13
+        - description: >-
+            A sub-identifier of the party identifier, or a sub-type of the party
+            identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`.
+          in: path
+          name: idSubValue
+          required: true
+          schema: &ref_18
+            type: string
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                properties: *ref_17
+                type: object
+          description: Response containing details of the requested party.
+        '400':
+          content: *ref_6
+          description: Malformed or missing required headers or parameters.
+        '404':
+          description: >-
+            The party specified by the provided identifier type and value is not
+            known to the server.
+        '500':
+          content: *ref_7
+          description: An error occurred processing the request.
+      summary: >-
+        Asks for the identifier (fspId) of the scheme participant (FSP) that can
+        handle transfers for the specified identifier type and value.
+      tags:
+        - Participants
+  /parties/{idType}/{idValue}:
+    get:
+      description: >-
+        The HTTP request `GET /parties/{idType}/{idValue}` is used to look up
+        information regarding the requested transfer party, identified by
+        `{idType}` and `{idValue}`.
+      operationId: BackendPartiesGetByTypeAndID
+      parameters:
+        - description: >-
+            The type of the party identifier. For example, `MSISDN`,
+            `PERSONAL_ID`.
+          in: path
+          name: idType
+          required: true
+          schema: *ref_16
+        - description: The identifier value.
+          in: path
+          name: idValue
+          required: true
+          schema: *ref_13
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                properties: *ref_1
+                required: *ref_2
+                type: object
+          description: Response containing details of the requested party.
+        '400':
+          content: *ref_6
+          description: Malformed or missing required headers or parameters.
+        '404':
+          description: >-
+            The party specified by the provided identifier type and value is not
+            known to the server.
+        '500':
+          content: *ref_7
+          description: An error occurred processing the request.
+      summary: >-
+        Requests information relating to a transfer party identified by the
+        specified identifier type and value.
+      tags:
+        - Parties
+  /parties/{idType}/{idValue}/{idSubValue}:
+    get:
+      description: >-
+        The HTTP request `GET /parties/{idType}/{idValue}/{idSubValue}` is used
+        to look up information regarding the requested transfer party,
+        identified by `{idType}`, `{idValue}` and `{idSubValue}`.
+      operationId: BackendPartiesGetByTypeIdAndSubId
+      parameters:
+        - description: >-
+            The type of the party identifier. For example, `MSISDN`,
+            `PERSONAL_ID`.
+          in: path
+          name: idType
+          required: true
+          schema: *ref_16
+        - description: The identifier value.
+          in: path
+          name: idValue
+          required: true
+          schema: *ref_13
+        - description: >-
+            A sub-identifier of the party identifier, or a sub-type of the party
+            identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`.
+          in: path
+          name: idSubValue
+          required: true
+          schema: *ref_18
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                properties: *ref_1
+                required: *ref_2
+                type: object
+          description: Response containing details of the requested party.
+        '400':
+          content: *ref_6
+          description: Malformed or missing required headers or parameters.
+        '404':
+          description: >-
+            The party specified by the provided identifier type and value is not
+            known to the server.
+        '500':
+          content: *ref_7
+          description: An error occurred processing the request.
+      summary: >-
+        Requests information relating to a transfer party identified by the
+        specified identifier type, value and subId value.
+      tags:
+        - Parties
+  /quoterequests:
+    post:
+      description: >-
+        The HTTP request `POST /quoterequests` is used to request the creation
+        of a quote for the provided financial transaction.
+      operationId: BackendQuoteRequest
+      requestBody:
+        content:
+          application/json:
+            schema:
+              description: A request for a quote for transfer from the DFSP backend.
+              properties: &ref_67
+                amount:
+                  description: >-
+                    Depending on `amountType`. If SEND - The amount the Payer
+                    would like to send, that is, the amount that should be
+                    withdrawn from the Payer account including any fees. The
+                    amount is updated by each participating entity in the
+                    transaction. If RECEIVE - The amount the Payee should
+                    receive, that is, the amount that should be sent to the
+                    receiver exclusive any fees. The amount is not updated by
+                    any of the participating entities.
+                  pattern: ^([0]|([1-9][0-9]{0,17}))([.][0-9]{0,3}[1-9])?$
+                  type: string
+                amountType:
+                  description: SEND for send amount, RECEIVE for receive amount.
+                  enum: *ref_8
+                  type: string
+                currency:
+                  enum: *ref_0
+                  maxLength: 3
+                  minLength: 3
+                  type: string
+                expiration:
+                  description: An ISO-8601 formatted timestamp.
+                  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)$
+                  type: string
+                extensionList:
+                  items: *ref_12
+                  maxItems: 16
+                  minItems: 0
+                  type: array
+                feesAmount:
+                  description: >-
+                    The fees in the transaction. The fees element should be
+                    empty if fees should be non-disclosed. The fees element
+                    should be non-empty if fees should be disclosed.
+                  pattern: ^([0]|([1-9][0-9]{0,17}))([.][0-9]{0,3}[1-9])?$
+                  type: string
+                feesCurrency:
+                  enum: *ref_0
+                  maxLength: 3
+                  minLength: 3
+                  type: string
+                from:
+                  description: >-
+                    Information about the Payer in the proposed financial
+                    transaction.
+                  properties: *ref_1
+                  required: *ref_2
+                  type: object
+                geoCode:
+                  description: >-
+                    Indicates the geographic location from where the transaction
+                    was initiated.
+                  properties: *ref_19
+                  required: *ref_20
+                  type: object
+                initiator:
+                  description: >-
+                    Specifies if the initiator of the transfer is the Payer or
+                    Payee.
+                  enum: *ref_9
+                  type: string
+                initiatorType:
+                  description: Specifies the type of the transaction initiator.
+                  enum: *ref_10
+                  type: string
+                note:
+                  description: An optional note associated with the requested transfer.
+                  maxLength: 128
+                  minLength: 1
+                  type: string
+                quoteId:
+                  description: A Mojaloop API quote identifier (UUID).
+                  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
+                subScenario:
+                  description: >-
+                    Possible sub-scenario, defined locally within the scheme
+                    (UndefinedEnum Type). Based on FSPIOP
+                    TransactionSubScenario.
+                  example: LOCALLY_DEFINED_SUBSCENARIO
+                  pattern: ^[A-Z_]{1,32}$
+                  title: transactionSubScenario
+                  type: string
+                to:
+                  description: >-
+                    Information about the Payee in the proposed financial
+                    transaction.
+                  properties: *ref_1
+                  required: *ref_2
+                  type: object
+                transactionId:
+                  description: >-
+                    ID of the transaction, the ID is decided by the Payer FSP
+                    during the creation of the quote.
+                  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
+                transactionType:
+                  description: Type of transaction for which the quote is requested.
+                  enum: *ref_11
+                  type: string
+              required: &ref_68
+                - quoteId
+                - transactionId
+                - to
+                - from
+                - amountType
+                - amount
+                - currency
+                - transactionType
+                - initiator
+                - initiatorType
+              type: object
+        description: Request for a transfer quotation.
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                description: A response to a request for a quote.
+                properties: &ref_25
+                  expiration:
+                    description: An ISO-8601 formatted timestamp.
+                    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)$
+                    type: string
+                  extensionList:
+                    items: *ref_12
+                    maxItems: 16
+                    minItems: 0
+                    type: array
+                  geoCode:
+                    description: >-
+                      Indicates the geographic location from where the
+                      transaction was initiated.
+                    properties: *ref_19
+                    required: *ref_20
+                    type: object
+                  payeeFspCommissionAmount:
+                    description: Transaction commission from the Payee FSP.
+                    pattern: ^([0]|([1-9][0-9]{0,17}))([.][0-9]{0,3}[1-9])?$
+                    type: string
+                  payeeFspCommissionAmountCurrency:
+                    description: Currency of the `payeeFspCommissionAmount`.
+                    enum: *ref_0
+                    maxLength: 3
+                    minLength: 3
+                    type: string
+                  payeeFspFeeAmount:
+                    description: Payee FSP’s part of the transaction fee.
+                    pattern: ^([0]|([1-9][0-9]{0,17}))([.][0-9]{0,3}[1-9])?$
+                    type: string
+                  payeeFspFeeAmountCurrency:
+                    description: The currency of the `payeeFspFeeAmount`.
+                    enum: *ref_0
+                    maxLength: 3
+                    minLength: 3
+                    type: string
+                  payeeReceiveAmount:
+                    description: >-
+                      The amount that the Payee should receive in the end-to-end
+                      transaction. Optional as the Payee FSP might not want to
+                      disclose any optional Payee fees.
+                    pattern: ^([0]|([1-9][0-9]{0,17}))([.][0-9]{0,3}[1-9])?$
+                    type: string
+                  payeeReceiveAmountCurrency:
+                    description: The currency of the `payeeReceiveAmount`.
+                    enum: *ref_0
+                    maxLength: 3
+                    minLength: 3
+                    type: string
+                  quoteId:
+                    description: A Mojaloop API quote identifier (UUID).
+                    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
+                  transactionId:
+                    description: >-
+                      ID of the transaction, the ID is decided by the Payer FSP
+                      during the creation of the quote.
+                    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:
+                    description: >-
+                      The amount of money that the Payer FSP should transfer to
+                      the Payee FSP.
+                    pattern: ^([0]|([1-9][0-9]{0,17}))([.][0-9]{0,3}[1-9])?$
+                    type: string
+                  transferAmountCurrency:
+                    description: The currency of the `transferAmount`.
+                    enum: *ref_0
+                    maxLength: 3
+                    minLength: 3
+                    type: string
+                required: &ref_26
+                  - quoteId
+                  - transactionId
+                  - transferAmount
+                  - transferAmountCurrency
+                type: object
+          description: A response to the transfer quotation request.
+        '400':
+          content: *ref_6
+          description: Malformed or missing required headers or parameters.
+        '500':
+          content: *ref_7
+          description: An error occurred processing the request.
+      summary: Requests a quote for the specified transfer.
+      tags:
+        - Quotes
+  /transactionrequests:
+    post:
+      operationId: BackendTransactionRequest
+      requestBody:
+        content:
+          application/json:
+            schema:
+              description: A request for a pull based transfer.
+              properties: &ref_70
+                amount:
+                  pattern: ^([0]|([1-9][0-9]{0,17}))([.][0-9]{0,3}[1-9])?$
+                  type: string
+                currency:
+                  enum: *ref_0
+                  maxLength: 3
+                  minLength: 3
+                  type: string
+                expiration:
+                  description: An ISO-8601 formatted timestamp.
+                  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)$
+                  type: string
+                from:
+                  properties: *ref_1
+                  required: *ref_2
+                  type: object
+                geoCode:
+                  description: >-
+                    Indicates the geographic location from where the transaction
+                    was initiated.
+                  properties: *ref_19
+                  required: *ref_20
+                  type: object
+                initiator:
+                  enum: *ref_9
+                  type: string
+                initiatorType:
+                  enum: *ref_10
+                  type: string
+                note:
+                  description: An optional note associated with the requested transfer.
+                  maxLength: 128
+                  minLength: 1
+                  type: string
+                to:
+                  properties: *ref_1
+                  required: *ref_2
+                  type: object
+                transactionRequestId:
+                  description: A Mojaloop API transaction request identifier (UUID).
+                  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
+                transactionType:
+                  enum: *ref_11
+                  type: string
+                subScenario:
+                  description: >-
+                    Possible sub-scenario, defined locally within the scheme
+                    (UndefinedEnum Type). Based on FSPIOP
+                    TransactionSubScenario.
+                  example: LOCALLY_DEFINED_SUBSCENARIO
+                  pattern: ^[A-Z_]{1,32}$
+                  title: transactionSubScenario
+                  type: string
+              required: &ref_71
+                - transactionRequestId
+                - to
+                - from
+                - amount
+                - currency
+                - transactionType
+                - initiator
+                - initiatorType
+              type: object
+        description: Request for Transaction Request.
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                description: A response to a request for a quote.
+                properties: &ref_72
+                  transactionId:
+                    description: >-
+                      ID of the transaction, the ID is decided by the Payer FSP
+                      during the creation of the quote.
+                    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:
+                    enum: &ref_74
+                      - RECEIVED
+                      - PENDING
+                      - ACCEPTED
+                      - REJECTED
+                    type: string
+                required: &ref_73
+                  - transactionId
+                  - transactionRequestState
+                type: object
+          description: A response to the transfer transaction request.
+        '400':
+          content: *ref_6
+          description: Malformed or missing required headers or parameters.
+        '500':
+          content: *ref_7
+          description: An error occurred processing the request.
+      summary: Transaction request that supports pull based transfers.
+      tags:
+        - TransactionRequest
+  /transfers:
+    post:
+      description: >-
+        The HTTP request `POST /transfers` is used to request the creation of a
+        transfer for the transfer party.
+      operationId: BackendTransfersPost
+      requestBody:
+        content:
+          application/json:
+            schema:
+              properties: &ref_80
+                amount:
+                  pattern: ^([0]|([1-9][0-9]{0,17}))([.][0-9]{0,3}[1-9])?$
+                  type: string
+                amountType:
+                  enum: *ref_8
+                  type: string
+                currency:
+                  enum: *ref_0
+                  maxLength: 3
+                  minLength: 3
+                  type: string
+                from:
+                  properties: *ref_1
+                  required: *ref_2
+                  type: object
+                ilpPacket:
+                  properties:
+                    data:
+                      description: Object containing transfer object.
+                      properties: &ref_62
+                        amount:
+                          description: >-
+                            Object containing Amount and Currency of the
+                            transfer.
+                          properties: &ref_51
+                            amount:
+                              pattern: ^([0]|([1-9][0-9]{0,17}))([.][0-9]{0,3}[1-9])?$
+                              type: string
+                            currency:
+                              enum: *ref_0
+                              maxLength: 3
+                              minLength: 3
+                              type: string
+                          required: &ref_52
+                            - amount
+                            - currency
+                          type: object
+                        payee:
+                          description: Data model for the complex type Party.
+                          properties: &ref_23
+                            merchantClassificationCode:
+                              description: >-
+                                A limited set of pre-defined numbers. This list
+                                would be a limited set of numbers identifying a
+                                set of popular merchant types like School Fees,
+                                Pubs and Restaurants, Groceries, etc.
+                              pattern: ^[\d]{1,4}$
+                              title: MerchantClassificationCode
+                              type: string
+                            name:
+                              description: >-
+                                Name of the Party. Could be a real name or a
+                                nickname.
+                              maxLength: 128
+                              minLength: 1
+                              title: PartyName
+                              type: string
+                            partyIdInfo:
+                              description: Data model for the complex type PartyIdInfo.
+                              properties: &ref_47
+                                extensionList:
+                                  description: >-
+                                    Data model for the complex type
+                                    ExtensionList
+                                  properties: &ref_34
+                                    extension:
+                                      description: Number of Extension elements
+                                      items:
+                                        description: >-
+                                          Data model for the complex type
+                                          Extension
+                                        properties: &ref_32
+                                          key:
+                                            description: Extension key.
+                                            maxLength: 32
+                                            minLength: 1
+                                            title: ExtensionKey
+                                            type: string
+                                          value:
+                                            description: Extension value.
+                                            maxLength: 128
+                                            minLength: 1
+                                            title: ExtensionValue
+                                            type: string
+                                        required: &ref_33
+                                          - key
+                                          - value
+                                        title: Extension
+                                        type: object
+                                      maxItems: 16
+                                      minItems: 1
+                                      type: array
+                                  required: &ref_35
+                                    - extension
+                                  title: ExtensionList
+                                  type: object
+                                fspId:
+                                  description: FSP identifier.
+                                  maxLength: 32
+                                  minLength: 1
+                                  title: FspId
+                                  type: string
+                                partyIdType:
+                                  description: >
+                                    This is a variant based on FSPIOP
+                                    `PartyIdType` specification.
+
+                                    Main difference being the CONSENT and
+                                    THIRD_PARTY_LINK enums.
+
+
+                                    Below are the allowed values for the
+                                    enumeration.
+
+                                    - MSISDN - An MSISDN (Mobile Station
+                                    International Subscriber Directory
+
+                                    Number, that is, the phone number) is used
+                                    as reference to a participant.
+
+                                    The MSISDN identifier should be in
+                                    international format according to the
+
+                                    [ITU-T E.164
+                                    standard](https://www.itu.int/rec/T-REC-E.164/en).
+
+                                    Optionally, the MSISDN may be prefixed by a
+                                    single plus sign, indicating the
+
+                                    international prefix.
+
+                                    - EMAIL - An email is used as reference to a
+
+                                    participant. The format of the email should
+                                    be according to the informational
+
+                                    [RFC
+                                    3696](https://tools.ietf.org/html/rfc3696).
+
+                                    - PERSONAL_ID - A personal identifier is
+                                    used as reference to a participant.
+
+                                    Examples of personal identification are
+                                    passport number, birth certificate
+
+                                    number, and national registration number.
+                                    The identifier number is added in
+
+                                    the PartyIdentifier element. The personal
+                                    identifier type is added in the
+
+                                    PartySubIdOrType element.
+
+                                    - BUSINESS - A specific Business (for
+                                    example, an organization or a company)
+
+                                    is used as reference to a participant. The
+                                    BUSINESS identifier can be in any
+
+                                    format. To make a transaction connected to a
+                                    specific username or bill number
+
+                                    in a Business, the PartySubIdOrType element
+                                    should be used.
+
+                                    - DEVICE - A specific device (for example, a
+                                    POS or ATM) ID connected to a
+
+                                    specific business or organization is used as
+                                    reference to a Party.
+
+                                    For referencing a specific device under a
+                                    specific business or organization,
+
+                                    use the PartySubIdOrType element.
+
+                                    - ACCOUNT_ID - A bank account number or FSP
+                                    account ID should be used as
+
+                                    reference to a participant. The ACCOUNT_ID
+                                    identifier can be in any format,
+
+                                    as formats can greatly differ depending on
+                                    country and FSP.
+
+                                    - IBAN - A bank account number or FSP
+                                    account ID is used as reference to a
+
+                                    participant. The IBAN identifier can consist
+                                    of up to 34 alphanumeric
+
+                                    characters and should be entered without
+                                    whitespace.
+
+                                    - ALIAS An alias is used as reference to a
+                                    participant. The alias should be
+
+                                    created in the FSP as an alternative
+                                    reference to an account owner.
+
+                                    Another example of an alias is a username in
+                                    the FSP system.
+
+                                    The ALIAS identifier can be in any format.
+                                    It is also possible to use the
+
+                                    PartySubIdOrType element for identifying an
+                                    account under an Alias defined
+
+                                    by the PartyIdentifier.
+
+                                    - CONSENT - TBD
+
+                                    - THIRD_PARTY_LINK - TBD
+                                  enum: &ref_49
+                                    - MSISDN
+                                    - EMAIL
+                                    - PERSONAL_ID
+                                    - BUSINESS
+                                    - DEVICE
+                                    - ACCOUNT_ID
+                                    - IBAN
+                                    - ALIAS
+                                    - CONSENT
+                                    - THIRD_PARTY_LINK
+                                  example: PERSONAL_ID
+                                  title: PartyIdType
+                                  type: string
+                                partyIdentifier:
+                                  description: Identifier of the Party.
+                                  example: '16135551212'
+                                  maxLength: 128
+                                  minLength: 1
+                                  title: PartyIdentifier
+                                  type: string
+                                partySubIdOrType:
+                                  description: >-
+                                    Either a sub-identifier of a
+                                    PartyIdentifier, or a sub-type of the
+                                    PartyIdType, normally a
+                                    PersonalIdentifierType.
+                                  maxLength: 128
+                                  minLength: 1
+                                  title: PartySubIdOrType
+                                  type: string
+                              required: &ref_48
+                                - partyIdType
+                                - partyIdentifier
+                              title: PartyIdInfo
+                              type: object
+                            personalInfo:
+                              description: >-
+                                Data model for the complex type
+                                PartyPersonalInfo.
+                              properties: &ref_50
+                                complexName:
+                                  description: >-
+                                    Data model for the complex type
+                                    PartyComplexName.
+                                  properties: &ref_46
+                                    displayName:
+                                      description: Display name of the sender if known
+                                      type: string
+                                    firstName:
+                                      description: First name of the Party (Name Type).
+                                      example: Henrik
+                                      maxLength: 128
+                                      minLength: 1
+                                      pattern: >-
+                                        ^(?!\s*$)[\p{L}\p{gc=Mark}\p{digit}\p{gc=Connector_Punctuation}\p{Join_Control}
+                                        .,''-]{1,128}$
+                                      title: FirstName
+                                      type: string
+                                    idSubValue:
+                                      description: >-
+                                        The sub identifier string used to
+                                        identify the sender
+                                      type: string
+                                    idType:
+                                      enum: *ref_21
+                                      type: string
+                                    idValue:
+                                      description: >-
+                                        The identifier string used to identify
+                                        the sender
+                                      type: string
+                                    lastName:
+                                      description: Last name of the Party (Name Type).
+                                      example: Karlsson
+                                      maxLength: 128
+                                      minLength: 1
+                                      pattern: >-
+                                        ^(?!\s*$)[\p{L}\p{gc=Mark}\p{digit}\p{gc=Connector_Punctuation}\p{Join_Control}
+                                        .,''-]{1,128}$
+                                      title: LastName
+                                      type: string
+                                    middleName:
+                                      description: Middle name of the Party (Name Type).
+                                      example: Johannes
+                                      maxLength: 128
+                                      minLength: 1
+                                      pattern: >-
+                                        ^(?!\s*$)[\p{L}\p{gc=Mark}\p{digit}\p{gc=Connector_Punctuation}\p{Join_Control}
+                                        .,''-]{1,128}$
+                                      title: MiddleName
+                                      type: string
+                                    type:
+                                      enum: *ref_22
+                                      type: string
+                                  title: PartyComplexName
+                                  type: object
+                                dateOfBirth:
+                                  description: Date of Birth of the Party.
+                                  example: '1966-06-16'
+                                  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)$
+                                  title: DateofBirth (type Date)
+                                  type: string
+                              title: PartyPersonalInfo
+                              type: object
+                          required: &ref_24
+                            - partyIdInfo
+                          title: Party
+                          type: object
+                        payer:
+                          description: Data model for the complex type Party.
+                          properties: *ref_23
+                          required: *ref_24
+                          title: Party
+                          type: object
+                        quoteId:
+                          description: A Mojaloop API quote identifier (UUID).
+                          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
+                        transactionId:
+                          description: >-
+                            ID of the transaction, the ID is decided by the
+                            Payer FSP during the creation of the quote.
+                          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
+                        transactionType:
+                          description: Object containing transfer object.
+                          properties: &ref_75
+                            initiator:
+                              enum: *ref_9
+                              type: string
+                            initiatorType:
+                              description: Specifies the type of the transaction initiator.
+                              enum: *ref_10
+                              type: string
+                            scenario:
+                              enum: &ref_69
+                                - TRANSFER
+                              type: string
+                            subScenario:
+                              description: >-
+                                Possible sub-scenario, defined locally within
+                                the scheme (UndefinedEnum Type). Based on FSPIOP
+                                TransactionSubScenario.
+                              example: LOCALLY_DEFINED_SUBSCENARIO
+                              pattern: ^[A-Z_]{1,32}$
+                              title: transactionSubScenario
+                              type: string
+                          required: &ref_76
+                            - scenario
+                            - initiator
+                            - initiatorType
+                          type: object
+                      required: &ref_63
+                        - quoteId
+                        - transactionId
+                        - payer
+                        - payee
+                        - amount
+                        - transactionType
+                      type: object
+                  required:
+                    - data
+                  type: object
+                note:
+                  maxLength: 128
+                  type: string
+                quote:
+                  description: A response to a request for a quote.
+                  properties: *ref_25
+                  required: *ref_26
+                  type: object
+                quoteRequestExtensions:
+                  items: *ref_12
+                  maxItems: 16
+                  minItems: 0
+                  type: array
+                subScenario:
+                  description: >-
+                    Possible sub-scenario, defined locally within the scheme
+                    (UndefinedEnum Type). Based on FSPIOP
+                    TransactionSubScenario.
+                  example: LOCALLY_DEFINED_SUBSCENARIO
+                  pattern: ^[A-Z_]{1,32}$
+                  title: transactionSubScenario
+                  type: string
+                to:
+                  properties: *ref_1
+                  required: *ref_2
+                  type: object
+                transactionType:
+                  enum: *ref_11
+                  type: string
+                transferId:
+                  description: A Mojaloop API transfer identifier (UUID).
+                  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
+              required: &ref_81
+                - transferId
+                - quote
+                - from
+                - to
+                - amountType
+                - currency
+                - amount
+                - transactionType
+                - ilpPacket
+              type: object
+        description: An incoming transfer request.
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                properties: &ref_82
+                  completedTimestamp:
+                    description: An ISO-8601 formatted timestamp.
+                    example: '2020-05-19T08:38:08.699-04:00'
+                    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)$
+                    type: string
+                  fulfilment:
+                    description: >-
+                      Fulfilment that must be attached to the transfer by the
+                      Payee.
+                    example: WLctttbu2HvTsa1XWvUoGRcQozHsqeu9Ahl2JW9Bsu8
+                    maxLength: 48
+                    pattern: ^[A-Za-z0-9-_]{43}$
+                    title: ilpFulfilment
+                    type: string
+                  homeTransactionId:
+                    description: >-
+                      Transaction ID from the DFSP backend, used to reconcile
+                      transactions between the Switch and DFSP backend systems.
+                    type: string
+                  transferState:
+                    description: >
+                      Below are the allowed values for the enumeration -
+                      RECEIVED DFSP has received the transfer. - RESERVED DFSP
+                      has reserved the transfer. - COMMITTED DFSP has
+                      successfully performed the transfer. - ABORTED DFSP has
+                      aborted the transfer due a rejection or failure to perform
+                      the transfer.
+                    example: ABORTED
+                    enum: &ref_27
+                      - RECEIVED
+                      - RESERVED
+                      - COMMITTED
+                      - ABORTED
+                    type: string
+                required: &ref_83
+                  - homeTransactionId
+                type: object
+          description: The transfer was accepted.
+        '400':
+          content: *ref_6
+          description: Malformed or missing required headers or parameters.
+        '500':
+          content: *ref_7
+          description: An error occurred processing the request.
+      summary: Transfers funds from an external account to an internal account.
+      tags:
+        - Transfers
+  /transfers/{transferId}:
+    get:
+      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.
+      operationId: BackendTransfersGet
+      parameters:
+        - in: path
+          name: transferId
+          required: true
+          schema: &ref_28
+            type: string
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                properties: &ref_77
+                  amount:
+                    pattern: ^([0]|([1-9][0-9]{0,17}))([.][0-9]{0,3}[1-9])?$
+                    type: string
+                  amountType:
+                    enum: *ref_8
+                    type: string
+                  currency:
+                    enum: *ref_0
+                    maxLength: 3
+                    minLength: 3
+                    type: string
+                  extensions:
+                    items: *ref_12
+                    maxItems: 16
+                    minItems: 0
+                    type: array
+                  from:
+                    properties: *ref_1
+                    required: *ref_2
+                    type: object
+                  homeTransactionId:
+                    description: >-
+                      Transaction ID from the DFSP backend, used to reconcile
+                      transactions between the Switch and DFSP backend systems.
+                    type: string
+                  note:
+                    maxLength: 128
+                    type: string
+                  subScenario:
+                    description: >-
+                      Possible sub-scenario, defined locally within the scheme
+                      (UndefinedEnum Type). Based on FSPIOP
+                      TransactionSubScenario.
+                    example: LOCALLY_DEFINED_SUBSCENARIO
+                    pattern: ^[A-Z_]{1,32}$
+                    title: transactionSubScenario
+                    type: string
+                  timestamp:
+                    description: An ISO-8601 formatted timestamp.
+                    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)$
+                    type: string
+                  to:
+                    properties: *ref_1
+                    required: *ref_2
+                    type: object
+                  transactionType:
+                    enum: *ref_11
+                    type: string
+                  transferState:
+                    description: >
+                      Below are the allowed values for the enumeration -
+                      RECEIVED DFSP has received the transfer. - RESERVED DFSP
+                      has reserved the transfer. - COMMITTED DFSP has
+                      successfully performed the transfer. - ABORTED DFSP has
+                      aborted the transfer due a rejection or failure to perform
+                      the transfer.
+                    enum: *ref_27
+                    type: string
+                required: &ref_78
+                  - homeTransactionId
+                  - from
+                  - to
+                  - amountType
+                  - currency
+                  - amount
+                  - transferState
+                  - transactionType
+                  - timestamp
+                type: object
+          description: The transfer was accepted.
+        '500':
+          content: *ref_7
+          description: An error occurred processing the request.
+      summary: Retrieves information for a specific transfer.
+      tags:
+        - Transfers
+    put:
+      description: >-
+        The HTTP request `PUT /transfers/{transferId}` is used to receive
+        notification for transfer being fulfiled when the FSP is a Payee.
+      operationId: BackendTransfersPut
+      parameters:
+        - in: path
+          name: transferId
+          required: true
+          schema: *ref_28
+      requestBody:
+        content:
+          application/json:
+            schema:
+              description: PUT /transfers/{transferId} object.
+              properties: &ref_61
+                currentState:
+                  enum: &ref_84
+                    - ERROR_OCCURRED
+                    - WAITING_FOR_PARTY_ACCEPTANCE
+                    - WAITING_FOR_QUOTE_ACCEPTANCE
+                    - COMPLETED
+                  type: string
+                direction:
+                  enum:
+                    - INBOUND
+                  type: string
+                finalNotification:
+                  properties:
+                    completedTimestamp:
+                      description: An ISO-8601 formatted timestamp.
+                      example: '2020-05-19T08:38:08.699-04:00'
+                      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)$
+                      type: string
+                    extensionList:
+                      description: Optional extension, specific to deployment.
+                      items: *ref_12
+                      maxItems: 16
+                      minItems: 0
+                      type: array
+                    transferState:
+                      description: >
+                        Below are the allowed values for the enumeration -
+                        RECEIVED DFSP has received the transfer. - RESERVED DFSP
+                        has reserved the transfer. - COMMITTED DFSP has
+                        successfully performed the transfer. - ABORTED DFSP has
+                        aborted the transfer due a rejection or failure to
+                        perform the transfer.
+                      example: COMMITTED
+                      enum: *ref_27
+                      type: string
+                  required:
+                    - completedTimestamp
+                    - transferState
+                  type: object
+                fulfil:
+                  properties:
+                    body:
+                      type: object
+                    headers:
+                      type: object
+                  type: object
+                initiatedTimestamp:
+                  description: An ISO-8601 formatted timestamp.
+                  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)$
+                  type: string
+                lastError:
+                  description: >-
+                    This object represents a Mojaloop API error received at any
+                    time during the transfer process.
+                  properties: &ref_79
+                    httpStatusCode:
+                      description: >-
+                        The HTTP status code returned to the caller. This is the
+                        same as the actual HTTP status code returned with the
+                        response.
+                      type: integer
+                    mojaloopError:
+                      description: >-
+                        If a transfer process results in an error callback
+                        during the asynchronous Mojaloop API exchange, this
+                        property will contain the underlying Mojaloop API error
+                        object.
+                      properties: &ref_64
+                        errorInformation:
+                          description: A Mojaloop API error information construct.
+                          properties: &ref_57
+                            errorCode:
+                              description: >
+                                The API data type errorCode is a JSON String of
+                                four characters, consisting of digits only.
+                                Negative numbers are not allowed. A leading zero
+                                is not allowed. Each error code in the API is a
+                                four-digit number, for example, 1234, where the
+                                first number (1 in the example) represents the
+                                high-level error category, the second number (2
+                                in the example) represents the low-level error
+                                category, and the last two numbers (34 in the
+                                example) represents the specific error.
+                              pattern: ^[1-9]\d{3}$
+                              title: ErrorCode
+                              type: string
+                            errorDescription:
+                              description: Error description string.
+                              maxLength: 128
+                              minLength: 1
+                              title: ErrorDescription
+                              type: string
+                            extensionList:
+                              description: Data model for the complex type ExtensionList.
+                              properties: &ref_59
+                                extension:
+                                  description: Number of Extension elements.
+                                  items:
+                                    properties: *ref_29
+                                    type: object
+                                  maxItems: 16
+                                  minItems: 1
+                                  type: array
+                              required: &ref_60
+                                - extension
+                              type: object
+                          required: &ref_58
+                            - errorCode
+                            - errorDescription
+                          title: ErrorInformation
+                          type: object
+                      type: object
+                  type: object
+                prepare:
+                  properties:
+                    body:
+                      type: object
+                    headers:
+                      type: object
+                  type: object
+                quote:
+                  properties:
+                    fulfilment:
+                      type: string
+                    internalRequest:
+                      type: object
+                    mojaloopResponse:
+                      type: object
+                    request:
+                      type: object
+                    response:
+                      type: object
+                  type: object
+                quoteRequest:
+                  properties:
+                    body:
+                      type: object
+                    headers:
+                      type: object
+                  type: object
+                quoteResponse:
+                  properties:
+                    body:
+                      type: object
+                    headers:
+                      type: object
+                  type: object
+                transferId:
+                  description: A Mojaloop API transfer identifier (UUID).
+                  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
+              title: TransfersIDPatchResponse
+              type: object
+        description: An incoming notification for fulfiled transfer.
+      responses:
+        '200':
+          description: The notification was accepted.
+        '500':
+          content: *ref_7
+          description: An error occurred processing the request.
+      summary: Receive notification for a specific transfer.
+      tags:
+        - Transfers
+components:
+  parameters:
+    bulkTransactionId:
+      description: Identifier of the bulk transaction to continue as returned in.
+      in: path
+      name: bulkTransactionId
+      required: true
+      schema: *ref_30
+    idSubValue:
+      description: >-
+        A sub-identifier of the party identifier, or a sub-type of the party
+        identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`.
+      in: path
+      name: idSubValue
+      required: true
+      schema: *ref_18
+    idType:
+      description: The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`.
+      in: path
+      name: idType
+      required: true
+      schema: *ref_16
+    idValue:
+      description: The identifier value.
+      in: path
+      name: idValue
+      required: true
+      schema: *ref_13
+    requestToPayId:
+      in: path
+      name: requestToPayId
+      required: true
+      schema: *ref_31
+    transferId:
+      in: path
+      name: transferId
+      required: true
+      schema: *ref_28
+  responses:
+    '400':
+      content: *ref_6
+      description: Malformed or missing required headers or parameters.
+    '404':
+      description: >-
+        The party specified by the provided identifier type and value is not
+        known to the server.
+    '500':
+      content: *ref_7
+      description: An error occurred processing the request.
+  schemas:
+    DateOfBirth:
+      description: Date of Birth of the Party.
+      example: '1966-06-16'
+      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)$
+      title: DateofBirth (type Date)
+      type: string
+    Extension:
+      description: Data model for the complex type Extension
+      properties: *ref_32
+      required: *ref_33
+      title: Extension
+      type: object
+    ExtensionKey:
+      description: Extension key.
+      maxLength: 32
+      minLength: 1
+      title: ExtensionKey
+      type: string
+    ExtensionList:
+      description: Data model for the complex type ExtensionList
+      properties: *ref_34
+      required: *ref_35
+      title: ExtensionList
+      type: object
+    ExtensionValue:
+      description: Extension value.
+      maxLength: 128
+      minLength: 1
+      title: ExtensionValue
+      type: string
+    FirstName:
+      description: First name of the Party (Name Type).
+      example: Henrik
+      maxLength: 128
+      minLength: 1
+      pattern: >-
+        ^(?!\s*$)[\p{L}\p{gc=Mark}\p{digit}\p{gc=Connector_Punctuation}\p{Join_Control}
+        .,''-]{1,128}$
+      title: FirstName
+      type: string
+    FspId:
+      description: FSP identifier.
+      maxLength: 32
+      minLength: 1
+      title: FspId
+      type: string
+    IndividualQuote:
+      description: Data model for individual quote in a bulk quote request.
+      properties: *ref_36
+      required: *ref_37
+      type: object
+    IndividualQuoteResultFailed:
+      description: Data model for failed individual quote in a bulk quote response.
+      properties: *ref_38
+      required: *ref_39
+      type: object
+    IndividualQuoteResultSuccess:
+      description: Data model for successful individual quote in a bulk quote response.
+      properties: *ref_40
+      required: *ref_41
+      type: object
+    IndividualTransfer:
+      description: Data model for individual transfer in a bulk transfer request.
+      properties: *ref_42
+      required: *ref_43
+      type: object
+    IndividualTransferResult:
+      description: Data model for individual transfer in a bulk transfer response.
+      properties: *ref_44
+      required: *ref_45
+      type: object
+    LastName:
+      description: Last name of the Party (Name Type).
+      example: Karlsson
+      maxLength: 128
+      minLength: 1
+      pattern: >-
+        ^(?!\s*$)[\p{L}\p{gc=Mark}\p{digit}\p{gc=Connector_Punctuation}\p{Join_Control}
+        .,''-]{1,128}$
+      title: LastName
+      type: string
+    MerchantClassificationCode:
+      description: >-
+        A limited set of pre-defined numbers. This list would be a limited set
+        of numbers identifying a set of popular merchant types like School Fees,
+        Pubs and Restaurants, Groceries, etc.
+      pattern: ^[\d]{1,4}$
+      title: MerchantClassificationCode
+      type: string
+    MiddleName:
+      description: Middle name of the Party (Name Type).
+      example: Johannes
+      maxLength: 128
+      minLength: 1
+      pattern: >-
+        ^(?!\s*$)[\p{L}\p{gc=Mark}\p{digit}\p{gc=Connector_Punctuation}\p{Join_Control}
+        .,''-]{1,128}$
+      title: MiddleName
+      type: string
+    Party:
+      description: Data model for the complex type Party.
+      properties: *ref_23
+      required: *ref_24
+      title: Party
+      type: object
+    PartyComplexName:
+      description: Data model for the complex type PartyComplexName.
+      properties: *ref_46
+      title: PartyComplexName
+      type: object
+    PartyIdInfo:
+      description: Data model for the complex type PartyIdInfo.
+      properties: *ref_47
+      required: *ref_48
+      title: PartyIdInfo
+      type: object
+    PartyIdType:
+      description: >
+        This is a variant based on FSPIOP `PartyIdType` specification.
+
+        Main difference being the CONSENT and THIRD_PARTY_LINK enums.
+
+
+        Below are the allowed values for the enumeration.
+
+        - MSISDN - An MSISDN (Mobile Station International Subscriber Directory
+
+        Number, that is, the phone number) is used as reference to a
+        participant.
+
+        The MSISDN identifier should be in international format according to the
+
+        [ITU-T E.164 standard](https://www.itu.int/rec/T-REC-E.164/en).
+
+        Optionally, the MSISDN may be prefixed by a single plus sign, indicating
+        the
+
+        international prefix.
+
+        - EMAIL - An email is used as reference to a
+
+        participant. The format of the email should be according to the
+        informational
+
+        [RFC 3696](https://tools.ietf.org/html/rfc3696).
+
+        - PERSONAL_ID - A personal identifier is used as reference to a
+        participant.
+
+        Examples of personal identification are passport number, birth
+        certificate
+
+        number, and national registration number. The identifier number is added
+        in
+
+        the PartyIdentifier element. The personal identifier type is added in
+        the
+
+        PartySubIdOrType element.
+
+        - BUSINESS - A specific Business (for example, an organization or a
+        company)
+
+        is used as reference to a participant. The BUSINESS identifier can be in
+        any
+
+        format. To make a transaction connected to a specific username or bill
+        number
+
+        in a Business, the PartySubIdOrType element should be used.
+
+        - DEVICE - A specific device (for example, a POS or ATM) ID connected to
+        a
+
+        specific business or organization is used as reference to a Party.
+
+        For referencing a specific device under a specific business or
+        organization,
+
+        use the PartySubIdOrType element.
+
+        - ACCOUNT_ID - A bank account number or FSP account ID should be used as
+
+        reference to a participant. The ACCOUNT_ID identifier can be in any
+        format,
+
+        as formats can greatly differ depending on country and FSP.
+
+        - IBAN - A bank account number or FSP account ID is used as reference to
+        a
+
+        participant. The IBAN identifier can consist of up to 34 alphanumeric
+
+        characters and should be entered without whitespace.
+
+        - ALIAS An alias is used as reference to a participant. The alias should
+        be
+
+        created in the FSP as an alternative reference to an account owner.
+
+        Another example of an alias is a username in the FSP system.
+
+        The ALIAS identifier can be in any format. It is also possible to use
+        the
+
+        PartySubIdOrType element for identifying an account under an Alias
+        defined
+
+        by the PartyIdentifier.
+
+        - CONSENT - TBD
+
+        - THIRD_PARTY_LINK - TBD
+      enum: *ref_49
+      example: PERSONAL_ID
+      title: PartyIdType
+      type: string
+    PartyIdentifier:
+      description: Identifier of the Party.
+      example: '16135551212'
+      maxLength: 128
+      minLength: 1
+      title: PartyIdentifier
+      type: string
+    PartyName:
+      description: Name of the Party. Could be a real name or a nickname.
+      maxLength: 128
+      minLength: 1
+      title: PartyName
+      type: string
+    PartyPersonalInfo:
+      description: Data model for the complex type PartyPersonalInfo.
+      properties: *ref_50
+      title: PartyPersonalInfo
+      type: object
+    PartySubIdOrType:
+      description: >-
+        Either a sub-identifier of a PartyIdentifier, or a sub-type of the
+        PartyIdType, normally a PersonalIdentifierType.
+      maxLength: 128
+      minLength: 1
+      title: PartySubIdOrType
+      type: string
+    amountCurrency:
+      description: Object containing Amount and Currency of the transfer.
+      properties: *ref_51
+      required: *ref_52
+      type: object
+    amountType:
+      enum: *ref_8
+      type: string
+    bulkQuoteId:
+      description: A Mojaloop API bulk quote identifier (UUID).
+      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
+    bulkQuoteRequest:
+      description: A request for a bulk quote.
+      properties: *ref_53
+      required: *ref_54
+      type: object
+    bulkQuoteResponse:
+      description: A response to a request for a bulk quote.
+      properties: *ref_4
+      required: *ref_5
+      type: object
+    bulkTransferId:
+      description: A Mojaloop API transfer identifier (UUID).
+      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
+    bulkTransferRequest:
+      properties: *ref_55
+      required: *ref_56
+      type: object
+    bulkTransferResponse:
+      properties: *ref_14
+      required: *ref_15
+      type: object
+    currency:
+      enum: *ref_0
+      maxLength: 3
+      minLength: 3
+      type: string
+    dateOfBirth:
+      description: Date of birth in the form YYYY-MM-DD.
+      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)$
+      type: string
+    errorCode:
+      description: >
+        The API data type errorCode is a JSON String of four characters,
+        consisting of digits only. Negative numbers are not allowed. A leading
+        zero is not allowed. Each error code in the API is a four-digit number,
+        for example, 1234, where the first number (1 in the example) represents
+        the high-level error category, the second number (2 in the example)
+        represents the low-level error category, and the last two numbers (34 in
+        the example) represents the specific error.
+      pattern: ^[1-9]\d{3}$
+      title: ErrorCode
+      type: string
+    errorDescription:
+      description: Error description string.
+      maxLength: 128
+      minLength: 1
+      title: ErrorDescription
+      type: string
+    errorInformation:
+      description: A Mojaloop API error information construct.
+      properties: *ref_57
+      required: *ref_58
+      title: ErrorInformation
+      type: object
+    errorResponse:
+      properties: *ref_3
+      type: object
+    extensionItem:
+      properties: *ref_29
+      type: object
+    extensionList:
+      items: *ref_12
+      maxItems: 16
+      minItems: 0
+      type: array
+    extensionListComplex:
+      description: Data model for the complex type ExtensionList.
+      properties: *ref_59
+      required: *ref_60
+      type: object
+    fspId:
+      description: FSP identifier.
+      maxLength: 32
+      minLength: 1
+      type: string
+    fulfilNotification:
+      description: PUT /transfers/{transferId} object.
+      properties: *ref_61
+      title: TransfersIDPatchResponse
+      type: object
+    generalError:
+      description: >-
+        This object may represent a number of different error object types and
+        so its properties may vary significantly.
+      type: object
+    geoCode:
+      description: >-
+        Indicates the geographic location from where the transaction was
+        initiated.
+      properties: *ref_19
+      required: *ref_20
+      type: object
+    idSubValue:
+      maxLength: 128
+      minLength: 1
+      type: string
+    idType:
+      enum: *ref_21
+      type: string
+    idValue:
+      description: Identifier of the party.
+      maxLength: 128
+      minLength: 1
+      type: string
+    ilpFulfilment:
+      description: Fulfilment that must be attached to the transfer by the Payee.
+      example: WLctttbu2HvTsa1XWvUoGRcQozHsqeu9Ahl2JW9Bsu8
+      maxLength: 48
+      pattern: ^[A-Za-z0-9-_]{43}$
+      title: ilpFulfilment
+      type: string
+    ilpPacketData:
+      description: Object containing transfer object.
+      properties: *ref_62
+      required: *ref_63
+      type: object
+    initiator:
+      enum: *ref_9
+      type: string
+    initiatorType:
+      enum: *ref_10
+      type: string
+    latitude:
+      description: >-
+        The API data type Latitude is a JSON String in a lexical format that is
+        restricted by a regular expression for interoperability reasons.
+      pattern: >-
+        ^(\+|-)?(?:90(?:(?:\.0{1,6})?)|(?:[0-9]|[1-8][0-9])(?:(?:\.[0-9]{1,6})?))$
+      type: string
+    longitude:
+      description: >-
+        The API data type Longitude is a JSON String in a lexical format that is
+        restricted by a regular expression for interoperability reasons.
+      pattern: >-
+        ^(\+|-)?(?:180(?:(?:\.0{1,6})?)|(?:[0-9]|[1-9][0-9]|1[0-7][0-9])(?:(?:\.[0-9]{1,6})?))$
+      type: string
+    mojaloopError:
+      properties: *ref_64
+      type: object
+    money:
+      pattern: ^([0]|([1-9][0-9]{0,17}))([.][0-9]{0,3}[1-9])?$
+      type: string
+    otpDetails:
+      properties: *ref_65
+      required: *ref_66
+      type: object
+    participantsResponse:
+      properties: *ref_17
+      type: object
+    payerType:
+      enum: *ref_22
+      type: string
+    quoteId:
+      description: A Mojaloop API quote identifier (UUID).
+      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
+    quoteRequest:
+      description: A request for a quote for transfer from the DFSP backend.
+      properties: *ref_67
+      required: *ref_68
+      type: object
+    quoteResponse:
+      description: A response to a request for a quote.
+      properties: *ref_25
+      required: *ref_26
+      type: object
+    scenario:
+      enum: *ref_69
+      type: string
+    timestamp:
+      description: An ISO-8601 formatted timestamp.
+      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)$
+      type: string
+    transactionId:
+      description: >-
+        ID of the transaction, the ID is decided by the Payer FSP during the
+        creation of the quote.
+      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
+    transactionRequest:
+      description: A request for a pull based transfer.
+      properties: *ref_70
+      required: *ref_71
+      type: object
+    transactionRequestId:
+      description: A Mojaloop API transaction request identifier (UUID).
+      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
+    transactionRequestResponse:
+      description: A response to a request for a quote.
+      properties: *ref_72
+      required: *ref_73
+      type: object
+    transactionRequestState:
+      enum: *ref_74
+      type: string
+    transactionSubScenario:
+      description: >-
+        Possible sub-scenario, defined locally within the scheme (UndefinedEnum
+        Type). Based on FSPIOP TransactionSubScenario.
+      example: LOCALLY_DEFINED_SUBSCENARIO
+      pattern: ^[A-Z_]{1,32}$
+      title: transactionSubScenario
+      type: string
+    transactionType:
+      enum: *ref_11
+      type: string
+    transactionTypeObject:
+      description: Object containing transfer object.
+      properties: *ref_75
+      required: *ref_76
+      type: object
+    transferDetailsResponse:
+      properties: *ref_77
+      required: *ref_78
+      type: object
+    transferError:
+      description: >-
+        This object represents a Mojaloop API error received at any time during
+        the transfer process.
+      properties: *ref_79
+      type: object
+    transferId:
+      description: A Mojaloop API transfer identifier (UUID).
+      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
+    transferParty:
+      properties: *ref_1
+      required: *ref_2
+      type: object
+    transferRequest:
+      properties: *ref_80
+      required: *ref_81
+      type: object
+    transferResponse:
+      properties: *ref_82
+      required: *ref_83
+      type: object
+    transferState:
+      description: >
+        Below are the allowed values for the enumeration - RECEIVED DFSP has
+        received the transfer. - RESERVED DFSP has reserved the transfer. -
+        COMMITTED DFSP has successfully performed the transfer. - ABORTED DFSP
+        has aborted the transfer due a rejection or failure to perform the
+        transfer.
+      enum: *ref_27
+      type: string
+    transferStatus:
+      enum: *ref_84
+      type: string