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

package/sdk-scheme-adapter/v2_1_0/components/schemas/requestToPayTransferResponse.yaml

@@ -0,0 +1,72 @@
+type: object
+required:
+  - transactionRequestId
+  - from
+  - to
+  - amountType
+  - currency
+  - amount
+  - transactionType
+properties:
+  transferId:
+    $ref: ./CorrelationId.yaml
+  homeR2PTransactionId:
+    type: string
+    description: >-
+      Transaction ID from the DFSP backend, used to reconcile transactions
+      between the Switch and DFSP backend systems.
+  transactionRequestId:
+    $ref: ./CorrelationId.yaml
+  from:
+    $ref: ./transferParty.yaml
+  to:
+    $ref: ./transferParty.yaml
+  amountType:
+    $ref: ./AmountType.yaml
+  currency:
+    $ref: ./Currency.yaml
+  amount:
+    $ref: ./Amount.yaml
+  transactionType:
+    $ref: ./transferTransactionType.yaml
+  note:
+    $ref: ./Note.yaml
+  currentState:
+    $ref: ./transferStatus.yaml
+  quoteId:
+    $ref: ./CorrelationId.yaml
+  quoteResponse:
+    type: object
+    required:
+      - body
+    properties:
+      body:
+        $ref: ./QuotesIDPutResponse.yaml
+      headers:
+        type: object
+  quoteResponseSource:
+    type: string
+    description: >
+      FSPID of the entity that supplied the quote response. This may not be the
+      same as the FSPID of the entity which owns the end user account in the
+      case of a FOREX transfer. i.e. it may be a FOREX gateway.
+  authorizationResponse:
+    type: object
+    required:
+      - body
+    properties:
+      body:
+        $ref: ./AuthorizationIDPutResponse.yaml
+      headers:
+        type: object
+  fulfil:
+    type: object
+    required:
+      - body
+    properties:
+      body:
+        $ref: ./TransfersIDPutResponse.yaml
+      headers:
+        type: object
+  lastError:
+    $ref: ./transferError.yaml

package/sdk-scheme-adapter/v2_1_0/components/schemas/simpleQuotesPostRequest.yaml

@@ -0,0 +1,10 @@
+title: simpleQuotesPostRequest
+type: object
+properties:
+  fspId:
+    $ref: ./FspId.yaml
+  quotesPostRequest:
+    $ref: ./QuotesPostRequest.yaml
+required:
+  - fspId
+  - quotesPostRequest

package/sdk-scheme-adapter/v2_1_0/components/schemas/simpleTransfersPostRequest.yaml

@@ -0,0 +1,10 @@
+title: SimpleTransfersPostRequest
+type: object
+properties:
+  fspId:
+    $ref: ./FspId.yaml
+  transfersPostRequest:
+    $ref: ./TransfersPostRequest.yaml
+required:
+  - fspId
+  - transfersPostRequest

package/sdk-scheme-adapter/v2_1_0/components/schemas/simpleTransfersPostResponse.yaml

@@ -0,0 +1,17 @@
+title: SimpleTransfersPostResponse
+type: object
+properties:
+  transfer:
+    properties:
+      body:
+        $ref: ./TransfersIDPutResponse.yaml
+      headers:
+        type: object
+    required:
+      - body
+      - headers
+  currentState:
+    $ref: ./async2SyncCurrentState.yaml
+required:
+  - transfer
+  - currentState

package/sdk-scheme-adapter/v2_1_0/components/schemas/transferContinuationAcceptConversion.yaml

@@ -0,0 +1,9 @@
+type: object
+required:
+  - acceptConversion
+properties:
+  acceptConversion:
+    type: boolean
+    enum:
+      - true
+      - false

package/sdk-scheme-adapter/v2_1_0/components/schemas/transferContinuationAcceptOTP.yaml

@@ -0,0 +1,9 @@
+type: object
+required:
+  - acceptOTP
+properties:
+  acceptOTP:
+    type: boolean
+    enum:
+      - true
+      - false

package/sdk-scheme-adapter/v2_1_0/components/schemas/transferContinuationAcceptParty.yaml

@@ -0,0 +1,9 @@
+type: object
+required:
+  - acceptParty
+properties:
+  acceptParty:
+    type: boolean
+    enum:
+      - true
+      - false

package/sdk-scheme-adapter/v2_1_0/components/schemas/transferContinuationAcceptQuote.yaml

@@ -0,0 +1,9 @@
+type: object
+required:
+  - acceptQuote
+properties:
+  acceptQuote:
+    type: boolean
+    enum:
+      - true
+      - false

package/sdk-scheme-adapter/v2_1_0/components/schemas/transferError.yaml

@@ -0,0 +1,12 @@
+type: object
+description: >-
+  This object represents a Mojaloop API error received at any time during the
+  transfer process
+properties:
+  httpStatusCode:
+    type: integer
+    description: >-
+      The HTTP status code returned to the caller. This is the same as the
+      actual HTTP status code returned with the response.
+  mojaloopError:
+    $ref: ./mojaloopError.yaml

package/sdk-scheme-adapter/v2_1_0/components/schemas/transferParty.yaml

@@ -0,0 +1,38 @@
+type: object
+required:
+  - idType
+  - idValue
+properties:
+  type:
+    $ref: ./TransactionInitiatorType.yaml
+  idType:
+    $ref: ./PartyIdType.yaml
+  idValue:
+    $ref: ./PartyIdentifier.yaml
+  idSubValue:
+    $ref: ./PartySubIdOrType.yaml
+  displayName:
+    $ref: ./Name.yaml
+  firstName:
+    $ref: ./FirstName.yaml
+  middleName:
+    $ref: ./MiddleName.yaml
+  lastName:
+    $ref: ./LastName.yaml
+  dateOfBirth:
+    $ref: ./DateOfBirth.yaml
+  merchantClassificationCode:
+    $ref: ./MerchantClassificationCode.yaml
+  fspId:
+    $ref: ./FspId.yaml
+  supportedCurrencies:
+    type: array
+    description: Currencies in which the party can receive funds.
+    items:
+      $ref: ./Currency.yaml
+    minItems: 0
+    maxItems: 16
+  kycInformation:
+    $ref: "../../../../fspiop/v2_0/openapi3/components/schemas/PartyPersonalInfo.yaml#/properties/kycInformation"
+  extensionList:
+    $ref: ./extensionListEmptiable.yaml

package/sdk-scheme-adapter/v2_1_0/components/schemas/transferRequest.yaml

@@ -0,0 +1,41 @@
+type: object
+required:
+  - homeTransactionId
+  - from
+  - to
+  - amountType
+  - currency
+  - amount
+  - transactionType
+properties:
+  homeTransactionId:
+    type: string
+    description: >-
+      Transaction ID from the DFSP backend, used to reconcile transactions
+      between the Switch and DFSP backend systems.
+  from:
+    $ref: ./transferParty.yaml
+  to:
+    $ref: ./transferParty.yaml
+  amountType:
+    $ref: ./AmountType.yaml
+  currency:
+    $ref: ./Currency.yaml
+  amount:
+    $ref: ./Amount.yaml
+  transactionType:
+    $ref: ./transferTransactionType.yaml
+  subScenario:
+    $ref: ./TransactionSubScenario.yaml
+  note:
+    $ref: ./Note.yaml
+  quoteRequestExtensions:
+    $ref: ./extensionListEmptiable.yaml
+  transferRequestExtensions:
+    $ref: ./extensionListEmptiable.yaml
+  skipPartyLookup:
+    description: >-
+      Set to true if supplying an FSPID for the payee party and no party
+      resolution is needed. This may be useful is a previous party resolution
+      has been performed.
+    type: boolean

package/sdk-scheme-adapter/v2_1_0/components/schemas/transferResponse.yaml

@@ -0,0 +1,93 @@
+type: object
+required:
+  - homeTransactionId
+  - from
+  - to
+  - amountType
+  - currency
+  - amount
+  - transactionType
+properties:
+  transferId:
+    $ref: ./CorrelationId.yaml
+  homeTransactionId:
+    type: string
+    description: >-
+      Transaction ID from the DFSP backend, used to reconcile transactions
+      between the Switch and DFSP backend systems.
+  from:
+    $ref: ./transferParty.yaml
+  to:
+    $ref: ./transferParty.yaml
+  amountType:
+    $ref: ./AmountType.yaml
+  currency:
+    $ref: ./Currency.yaml
+  amount:
+    $ref: ./Amount.yaml
+  transactionType:
+    $ref: ./transferTransactionType.yaml
+  subScenario:
+    $ref: ./TransactionSubScenario.yaml
+  note:
+    $ref: ./Note.yaml
+  currentState:
+    $ref: ./transferStatus.yaml
+  quoteId:
+    $ref: ./CorrelationId.yaml
+  getPartiesResponse:
+    type: object
+    required:
+      - body
+    properties:
+      body:
+        type: object
+      headers:
+        type: object
+  quoteResponse:
+    type: object
+    required:
+      - body
+    properties:
+      body:
+        $ref: ./QuotesIDPutResponse.yaml
+      headers:
+        type: object
+  quoteResponseSource:
+    type: string
+    description: >
+      FSPID of the entity that supplied the quote response. This may not be the
+      same as the FSPID of the entity which owns the end user account in the
+      case of a FOREX transfer. i.e. it may be a FOREX gateway.
+  conversionRequestId:
+    $ref: ./CorrelationId.yaml
+  fxQuotesResponse:
+    type: object
+    required:
+      - body
+    properties:
+      body:
+        $ref: ./FxQuotesPostOutboundResponse.yaml
+      headers:
+        type: object
+  fxQuotesResponseSource:
+    type: string
+    description: >
+      FXPID of the entity that supplied the fxQuotes response.
+  fulfil:
+    type: object
+    required:
+      - body
+    properties:
+      body:
+        $ref: ./TransfersIDPutResponse.yaml
+      headers:
+        type: object
+  lastError:
+    $ref: ./transferError.yaml
+  skipPartyLookup:
+    description: >-
+      Set to true if supplying an FSPID for the payee party and no party
+      resolution is needed. This may be useful is a previous party resolution
+      has been performed.
+    type: boolean

package/sdk-scheme-adapter/v2_1_0/components/schemas/transferStatus.yaml

@@ -0,0 +1,7 @@
+type: string
+enum:
+  - ERROR_OCCURRED
+  - WAITING_FOR_PARTY_ACCEPTANCE
+  - WAITING_FOR_QUOTE_ACCEPTANCE
+  - WAITING_FOR_CONVERSION_ACCEPTANCE
+  - COMPLETED

package/sdk-scheme-adapter/v2_1_0/components/schemas/transferStatusResponse.yaml

@@ -0,0 +1,19 @@
+type: object
+required:
+  - transferId
+  - currentState
+  - fulfil
+properties:
+  transferId:
+    $ref: ./CorrelationId.yaml
+  currentState:
+    $ref: ./transferStatus.yaml
+  fulfil:
+    type: object
+    required:
+      - body
+    properties:
+      body:
+        $ref: ./TransfersIDPutResponse.yaml
+      headers:
+        type: object

package/sdk-scheme-adapter/v2_1_0/components/schemas/transferTransactionType.yaml

@@ -0,0 +1,5 @@
+title: transferTransactionType
+type: string
+enum:
+  - TRANSFER
+description: Type of transaction.

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

@@ -0,0 +1,66 @@
+openapi: 3.0.1
+info:
+  title: Mojaloop SDK Outbound Scheme Adapter API
+  description: >
+    Specification for the Mojaloop SDK Scheme Adapter Outbound Transfers API
+
+
+    This API can be used by DFSP backends to simplify the process of sending
+    funds to other parties within a Mojaloop scheme.
+
+
+    Please see other documentation on
+    https://github.com/mojaloop/sdk-scheme-adapter for more information.
+
+
+    **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: https://github.com/mojaloop/documentation/blob/main/LICENSE.md
+  version: 2.1.0
+paths:
+  /:
+    $ref: paths.yaml
+  /accounts:
+    $ref: paths/accounts.yaml
+  /bulkQuotes:
+    $ref: paths/bulkQuotes.yaml
+  /bulkQuotes/{bulkQuoteId}:
+    $ref: paths/bulkQuotes_bulkQuoteId.yaml
+  /bulkTransactions:
+    $ref: paths/bulkTransactions.yaml
+  /bulkTransactions/{bulkTransactionId}:
+    $ref: paths/bulkTransactions_bulkTransactionId.yaml
+  /bulkTransfers:
+    $ref: paths/bulkTransfers.yaml
+  /bulkTransfers/{bulkTransferId}:
+    $ref: paths/bulkTransfers_bulkTransferId.yaml
+  /parties/{Type}/{ID}:
+    $ref: paths/parties_Type_ID.yaml
+  /parties/{Type}/{ID}/{SubId}:
+    $ref: paths/parties_Type_ID_SubId.yaml
+  /quotes:
+    $ref: paths/quotes.yaml
+  /requestToPay:
+    $ref: paths/requestToPay.yaml
+  /requestToPay/{transactionRequestId}:
+    $ref: paths/requestToPay_transactionRequestId.yaml
+  /requestToPayTransfer:
+    $ref: paths/requestToPayTransfer.yaml
+  /requestToPayTransfer/{transactionRequestId}:
+    $ref: paths/requestToPayTransfer_transactionRequestId.yaml
+  /simpleTransfers:
+    $ref: paths/simpleTransfers.yaml
+  /transfers:
+    $ref: paths/transfers.yaml
+  /transfers/{transferId}:
+    $ref: paths/transfers_transferId.yaml
+  /services/FXP:
+    $ref: 'paths/services_FXP.yaml'
+  /services/FXP/{SourceCurrency}/{TargetCurrency}:
+    $ref: 'paths/services_FXP_SourceCurrency_TargetCurrency.yaml'
+  /fxQuotes:
+    $ref: 'paths/fxQuotes.yaml'
+  /fxTransfers:
+    $ref: 'paths/fxTransfers.yaml'

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

@@ -0,0 +1,26 @@
+post:
+  summary: Create accounts on the Account Lookup Service
+  description: >-
+    The HTTP request `POST /accounts` is used to create account information on
+    the Account Lookup Service (ALS) regarding the provided list of identities.
+
+
+    Caller DFSP is used as the account source FSP information
+  tags:
+    - Accounts
+  requestBody:
+    description: Identities list request body
+    content:
+      application/json:
+        schema:
+          $ref: ../../components/schemas/accountsRequest.yaml
+    required: true
+  responses:
+    '200':
+      $ref: ../../components/responses/accountsCreationCompleted.yaml
+    '400':
+      $ref: ../../components/responses/accountsCreationError.yaml
+    '500':
+      $ref: ../../components/responses/accountsCreationError.yaml
+    '504':
+      $ref: ../../components/responses/accountsCreationTimeout.yaml

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

@@ -0,0 +1,23 @@
+post:
+  summary: Request bulk quotes for the provided financial transactions
+  description: >
+    The HTTP request `POST /bulkQuotes` is used to request a bulk quote to
+    fascilitate funds transfer from payer DFSP to payees' DFSP.
+  tags:
+    - BulkQuotes
+  requestBody:
+    description: Bulk quote request body
+    content:
+      application/json:
+        schema:
+          $ref: ../../components/schemas/bulkQuoteRequest.yaml
+    required: true
+  responses:
+    '200':
+      $ref: ../../components/responses/bulkQuoteSuccess.yaml
+    '400':
+      $ref: ../../components/responses/bulkQuoteBadRequest.yaml
+    '500':
+      $ref: ../../components/responses/bulkQuoteServerError.yaml
+    '504':
+      $ref: ../../components/responses/bulkQuoteTimeout.yaml

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

@@ -0,0 +1,24 @@
+get:
+  summary: Retrieves information for a specific bulk quote
+  description: >-
+    The HTTP request `GET /bulkQuotes/{bulktQuoteId}` is used to get information
+    regarding a bulk quote created or requested earlier. The `{bulkQuoteId}` in
+    the URI should contain the `bulkQuoteId` that was used for the creation of
+    the bulk quote.
+  tags:
+    - BulkQuotes
+  parameters:
+    - $ref: ../../components/parameters/bulkQuoteId.yaml
+  responses:
+    '200':
+      description: Bulk quote information successfully retrieved
+      content:
+        application/json:
+          schema:
+            $ref: ../../components/schemas/bulkQuoteStatusResponse.yaml
+    '500':
+      description: An error occurred processing the bulk quote
+      content:
+        application/json:
+          schema:
+            $ref: ../../components/schemas/errorResponse.yaml

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

@@ -0,0 +1,21 @@
+post:
+  summary: Sends money from one account to multiple accounts
+  description: >
+    The HTTP request `POST /bulkTransactions` is used to request the movement of
+    funds from payer DFSP to payees' DFSP.
+  tags:
+    - BulkTransactions
+  requestBody:
+    description: Bulk transfer request body
+    content:
+      application/json:
+        schema:
+          $ref: ../../components/schemas/bulkTransactionRequest.yaml
+    required: true
+  responses:
+    '202':
+      $ref: ../../components/responses/bulkTransactionAccepted.yaml
+    '400':
+      $ref: ../../components/responses/bulkTransferBadRequest.yaml
+    '500':
+      $ref: ../../components/responses/errorResponse.yaml

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

@@ -0,0 +1,33 @@
+put:
+  summary: Amends the bulk transaction request
+  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.
+  tags:
+    - BulkTransactions
+  parameters:
+    - $ref: ../../components/parameters/bulkTransactionId.yaml
+  requestBody:
+    description: Bulk transaction request body
+    content:
+      application/json:
+        schema:
+          oneOf:
+            - $ref: ../../components/schemas/bulkTransactionContinuationAcceptParty.yaml
+            - $ref: ../../components/schemas/bulkTransactionContinuationAcceptQuote.yaml
+    required: true
+  responses:
+    '202':
+      description: Bulk transaction information successfully amended
+    '400':
+      $ref: ../../components/responses/bulkTransactionPutBadRequest.yaml
+    '500':
+      description: An error occurred processing the bulk transaction
+      content:
+        application/json:
+          schema:
+            $ref: ../../components/schemas/errorResponse.yaml

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

@@ -0,0 +1,21 @@
+post:
+  summary: Sends money from one account to multiple accounts
+  description: >
+    The HTTP request `POST /bulkTransfers` is used to request the movement of
+    funds from payer DFSP to payees' DFSP.
+  tags:
+    - BulkTransfers
+  requestBody:
+    description: Bulk transfer request body
+    content:
+      application/json:
+        schema:
+          $ref: ../../components/schemas/bulkTransferRequest.yaml
+    required: true
+  responses:
+    '200':
+      $ref: ../../components/responses/bulkTransferSuccess.yaml
+    '400':
+      $ref: ../../components/responses/bulkTransferBadRequest.yaml
+    '500':
+      $ref: ../../components/responses/errorResponse.yaml

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

@@ -0,0 +1,24 @@
+get:
+  summary: Retrieves information for a specific bulk transfer
+  description: >-
+    The HTTP request `GET /bulkTransfers/{bulkTransferId}` is used to get
+    information regarding a bulk transfer created or requested earlier. The
+    `{bulkTransferId}` in the URI should contain the `bulkTransferId` that
+    was used for the creation of the bulk transfer.
+  tags:
+    - BulkTransfers
+  parameters:
+    - $ref: ../../components/parameters/bulkTransferId.yaml
+  responses:
+    '200':
+      description: Bulk transfer information successfully retrieved
+      content:
+        application/json:
+          schema:
+            $ref: ../../components/responses/bulkTransferStatusResponse.yaml
+    '500':
+      description: An error occurred processing the bulk transfer
+      content:
+        application/json:
+          schema:
+            $ref: ../../components/schemas/errorResponse.yaml

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

@@ -0,0 +1,26 @@
+post:
+  description: >-
+    The HTTP request `POST /fxQuotes` is used to ask to provide a quotation for a currency conversion.
+  summary: Calculate FX quote
+  tags:
+    - Fx
+  operationId: FxQuotesPost
+  requestBody:
+    description: Details of the FX quote request.
+    required: true
+    content:
+      application/json:
+        schema:
+          $ref: ../../components/schemas/FxQuotesPostOutboundRequest.yaml
+  responses:
+    '200':
+      description: Successful response.
+      content:
+        application/json:
+          schema:
+            $ref: ../../components/schemas/FxQuotesPostOutboundResponse.yaml
+    '400':
+      $ref: ../../components/responses/400.yaml
+    '500':
+      $ref: ../../components/responses/500.yaml
+

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

@@ -0,0 +1,25 @@
+post:
+  description: >-
+    The HTTP request `POST /fxTransfers` is used to ask to confirm the execution of an agreed currency conversion.
+  summary: Perform FX transfer
+  tags:
+    - Fx
+  operationId: FxTransfersPost
+  requestBody:
+    description: Details of the FX transfer request.
+    required: true
+    content:
+      application/json:
+        schema:
+          $ref: ../../components/schemas/FxTransfersPostOutboundRequest.yaml
+  responses:
+    '200':
+      description: Successful response.
+      content:
+        application/json:
+          schema:
+            $ref: ../../components/schemas/FxTransfersPostOutboundResponse.yaml
+    '400':
+      $ref: ../../components/responses/400.yaml
+    '500':
+      $ref: ../../components/responses/500.yaml