@mojaloop/api-snippets 17.2.5 → 17.3.0

package/fspiop/v2_0/openapi3/components/schemas/TransactionInitiatorType.yaml

@@ -0,0 +1,14 @@
+title: TransactionInitiatorType
+type: string
+enum:
+  - CONSUMER
+  - AGENT
+  - BUSINESS
+  - DEVICE
+description: |-
+  Below are the allowed values for the enumeration.
+  - CONSUMER - Consumer is the initiator of the transaction.
+  - AGENT - Agent is the initiator of the transaction.
+  - BUSINESS - Business is the initiator of the transaction.
+  - DEVICE - Device is the initiator of the transaction.
+example: 'CONSUMER'

package/fspiop/v2_0/openapi3/components/schemas/TransactionRequestState.yaml

@@ -0,0 +1,14 @@
+title: TransactionRequestState
+type: string
+enum:
+  - RECEIVED
+  - PENDING
+  - ACCEPTED
+  - REJECTED
+description: |-
+  Below are the allowed values for the enumeration.
+  - RECEIVED - Payer FSP has received the transaction from the Payee FSP.
+  - PENDING - Payer FSP has sent the transaction request to the Payer.
+  - ACCEPTED - Payer has approved the transaction.
+  - REJECTED - Payer has rejected the transaction.
+example: 'RECEIVED'

package/fspiop/v2_0/openapi3/components/schemas/TransactionRequestsIDPutResponse.yaml

@@ -0,0 +1,12 @@
+title: TransactionRequestsIDPutResponse
+type: object
+description: 'The object sent in the PUT /transactionRequests/{ID} callback.'
+properties:
+  transactionId:
+    $ref: ./CorrelationId.yaml
+  transactionRequestState:
+    $ref: ./TransactionRequestState.yaml
+  extensionList:
+    $ref: ./ExtensionList.yaml
+required:
+  - transactionRequestState

package/fspiop/v2_0/openapi3/components/schemas/TransactionRequestsPostRequest.yaml

@@ -0,0 +1,30 @@
+title: TransactionRequestsPostRequest
+type: object
+description: The object sent in the POST /transactionRequests request.
+properties:
+  transactionRequestId:
+    $ref: ./CorrelationId.yaml
+  payee:
+    $ref: ./Party.yaml
+  payer:
+    $ref: ./PartyIdInfo.yaml
+  amount:
+    $ref: ./Money.yaml
+  transactionType:
+    $ref: ./TransactionType.yaml
+  note:
+    $ref: ./Note.yaml
+  geoCode:
+    $ref: ./GeoCode.yaml
+  authenticationType:
+    $ref: ./AuthenticationType.yaml
+  expiration:
+    $ref: ./DateTime.yaml
+  extensionList:
+    $ref: ./ExtensionList.yaml
+required:
+  - transactionRequestId
+  - payee
+  - payer
+  - amount
+  - transactionType

package/fspiop/v2_0/openapi3/components/schemas/TransactionScenario.yaml

@@ -0,0 +1,32 @@
+title: TransactionScenario
+type: string
+enum:
+  - DEPOSIT
+  - WITHDRAWAL
+  - TRANSFER
+  - PAYMENT
+  - REFUND
+description: >-
+  Below are the allowed values for the enumeration.
+
+  - DEPOSIT - Used for performing a Cash-In (deposit) transaction. In a normal
+  scenario, electronic funds are transferred from a Business account to a
+  Consumer account, and physical cash is given from the Consumer to the Business
+  User.
+
+  - WITHDRAWAL - Used for performing a Cash-Out (withdrawal) transaction. In a
+  normal scenario, electronic funds are transferred from a Consumer’s account to
+  a Business account, and physical cash is given from the Business User to the
+  Consumer.
+
+  - TRANSFER - Used for performing a P2P (Peer to Peer, or Consumer to Consumer)
+  transaction.
+
+  - PAYMENT - Usually used for performing a transaction from a Consumer to a
+  Merchant or Organization, but could also be for a B2B (Business to Business)
+  payment. The transaction could be online for a purchase in an Internet store,
+  in a physical store where both the Consumer and Business User are present, a
+  bill payment, a donation, and so on.
+
+  - REFUND - Used for performing a refund of transaction.
+example: 'DEPOSIT'

package/fspiop/v2_0/openapi3/components/schemas/TransactionState.yaml

@@ -0,0 +1,14 @@
+title: TransactionState
+type: string
+enum:
+  - RECEIVED
+  - PENDING
+  - COMPLETED
+  - REJECTED
+description: |-
+  Below are the allowed values for the enumeration.
+  - RECEIVED - Payee FSP has received the transaction from the Payer FSP.
+  - PENDING - Payee FSP has validated the transaction.
+  - COMPLETED - Payee FSP has successfully performed the transaction.
+  - REJECTED - Payee FSP has failed to perform the transaction.
+example: 'RECEIVED'

package/fspiop/v2_0/openapi3/components/schemas/TransactionSubScenario.yaml

@@ -0,0 +1,5 @@
+title: TransactionSubScenario
+type: string
+pattern: '^[A-Z_]{1,32}$'
+description: 'Possible sub-scenario, defined locally within the scheme (UndefinedEnum Type).'
+example: 'LOCALLY_DEFINED_SUBSCENARIO'

package/fspiop/v2_0/openapi3/components/schemas/TransactionType.yaml

@@ -0,0 +1,20 @@
+title: TransactionType
+type: object
+description: Data model for the complex type TransactionType.
+properties:
+  scenario:
+    $ref: ./TransactionScenario.yaml
+  subScenario:
+    $ref: ./TransactionSubScenario.yaml
+  initiator:
+    $ref: ./TransactionInitiator.yaml
+  initiatorType:
+    $ref: ./TransactionInitiatorType.yaml
+  refundInfo:
+    $ref: ./Refund.yaml
+  balanceOfPayments:
+    $ref: ./BalanceOfPayments.yaml
+required:
+  - scenario
+  - initiator
+  - initiatorType

package/fspiop/v2_0/openapi3/components/schemas/TransactionsIDPutResponse.yaml

@@ -0,0 +1,14 @@
+title: TransactionsIDPutResponse
+type: object
+description: 'The object sent in the PUT /transactions/{ID} callback.'
+properties:
+  completedTimestamp:
+    $ref: ./DateTime.yaml
+  transactionState:
+    $ref: ./TransactionState.yaml
+  code:
+    $ref: ./Code.yaml
+  extensionList:
+    $ref: ./ExtensionList.yaml
+required:
+  - transactionState

package/fspiop/v2_0/openapi3/components/schemas/TransferState.yaml

@@ -0,0 +1,19 @@
+title: TransferState
+type: string
+enum:
+  - RECEIVED
+  - RESERVED
+  - COMMITTED
+  - ABORTED
+description: >-
+  Below are the allowed values for the enumeration.
+
+  - RECEIVED - Next ledger has received the transfer.
+
+  - RESERVED - Next ledger has reserved the transfer.
+
+  - COMMITTED - Next ledger has successfully performed the transfer.
+
+  - ABORTED - Next ledger has aborted the transfer due to a rejection or failure
+  to perform the transfer.
+example: 'RESERVED'

package/fspiop/v2_0/openapi3/components/schemas/TransfersIDPatchResponse.yaml

@@ -0,0 +1,13 @@
+title: TransfersIDPatchResponse
+type: object
+description: 'PATCH /transfers/{ID} object'
+properties:
+  completedTimestamp:
+    $ref: ./DateTime.yaml
+  transferState:
+    $ref: ./TransferState.yaml
+  extensionList:
+    $ref: ./ExtensionList.yaml
+required:
+  - completedTimestamp
+  - transferState

package/fspiop/v2_0/openapi3/components/schemas/TransfersIDPutResponse.yaml

@@ -0,0 +1,14 @@
+title: TransfersIDPutResponse
+type: object
+description: 'The object sent in the PUT /transfers/{ID} callback.'
+properties:
+  fulfilment:
+    $ref: ./IlpFulfilment.yaml
+  completedTimestamp:
+    $ref: ./DateTime.yaml
+  transferState:
+    $ref: ./TransferState.yaml
+  extensionList:
+    $ref: ./ExtensionList.yaml
+required:
+  - transferState

package/fspiop/v2_0/openapi3/components/schemas/TransfersPostRequest.yaml

@@ -0,0 +1,28 @@
+title: TransfersPostRequest
+type: object
+description: The object sent in the POST /transfers request.
+properties:
+  transferId:
+    $ref: ./CorrelationId.yaml
+  payeeFsp:
+    $ref: ./FspId.yaml
+  payerFsp:
+    $ref: ./FspId.yaml
+  amount:
+    $ref: ./Money.yaml
+  ilpPacket:
+    $ref: ./IlpPacket.yaml
+  condition:
+    $ref: ./IlpCondition.yaml
+  expiration:
+    $ref: ./DateTime.yaml
+  extensionList:
+    $ref: ./ExtensionList.yaml
+required:
+  - transferId
+  - payeeFsp
+  - payerFsp
+  - amount
+  - ilpPacket
+  - condition
+  - expiration

package/fspiop/v2_0/openapi3/components/schemas/U2FPIN.yaml

@@ -0,0 +1,8 @@
+title: U2FPIN
+type: string
+pattern: '^\S{1,64}$'
+minLength: 1
+maxLength: 64
+description: >
+  U2F challenge-response, where payer FSP verifies if the response
+  provided by end-user device matches the previously registered key.

package/fspiop/v2_0/openapi3/components/schemas/U2FPinValue.yaml

@@ -0,0 +1,19 @@
+title: U2FPinValue
+type: object
+description: >
+  U2F challenge-response, where payer FSP verifies if the response
+  provided by end-user device matches the previously registered key.
+properties:
+  pinValue:
+    allOf:
+      - $ref: ./U2FPIN.yaml
+    description: U2F challenge-response.
+  counter:
+    allOf:
+      - $ref: './Integer.yaml'
+    description: >-
+      Sequential counter used for cloning detection. Present only for U2F
+      authentication.
+required:
+  - pinValue
+  - counter

package/fspiop/v2_0/openapi3/components/schemas/UndefinedEnum.yaml

@@ -0,0 +1,6 @@
+title: UndefinedEnum
+type: string
+pattern: '^[A-Z_]{1,32}$'
+description: >-
+  The API data type UndefinedEnum is a JSON String consisting of 1 to 32
+  uppercase characters including an underscore character (_).

package/fspiop/v2_0/openapi3/openapi.yaml

@@ -0,0 +1,136 @@
+openapi: 3.0.2
+info:
+  version: '2.0-draft'
+  title: Open API for FSP Interoperability (FSPIOP)
+  description: >-
+    Revision date: 2023-11-23
+    Based on [API Definition updated on 2020-05-19 Version
+    1.1](https://github.com/mojaloop/mojaloop-specification/blob/main/documents/v1.1-document-set/API%20Definition_v1.1.pdf).
+
+    This is implementation friendly version of the API definition.
+
+    It includes the below definitions needed for third-party functionality.
+    - AuthenticationType
+      - U2F enum
+    - AuthenticationValue
+      - oneOf is changed to anyOf
+      - new element is added U2FPinValue
+    - New element U2FPIN
+
+    **Note:** The API supports a maximum size of 65536 bytes (64 Kilobytes) in
+    the HTTP header.
+  license:
+    name: CC BY-ND 4.0
+    url: 'https://github.com/mojaloop/mojaloop-specification/blob/main/LICENSE.md'
+  contact:
+    name: Sam Kummary
+    url: 'https://github.com/mojaloop/mojaloop-specification/issues'
+servers:
+  - url: 'protocol://hostname:<port>/switch/'
+    variables:
+      protocol:
+        enum:
+          - http
+          - https
+        default: https
+paths:
+  /interface:
+    post:
+      description: >-
+        Essential path to include schema definitions that are not used so that
+        these definitions get included into the openapi-cli bundle api
+        definition so that they get converted into typescript definitions.
+      operationId: test
+      requestBody:
+        content:
+          application/json:
+            schema:
+              oneOf:
+                - $ref: './components/schemas/BinaryString.yaml'
+                - $ref: './components/schemas/BinaryString32.yaml'
+                - $ref: './components/schemas/Date.yaml'
+                - $ref: './components/schemas/Integer.yaml'
+                - $ref: './components/schemas/Name.yaml'
+                - $ref: './components/schemas/PersonalIdentifierType.yaml'
+                - $ref: './components/schemas/TokenCode.yaml'
+                - $ref: './components/schemas/Transaction.yaml'
+                - $ref: './components/schemas/UndefinedEnum.yaml'
+      responses:
+        200:
+          description: Ok
+  /participants/{Type}/{ID}:
+    $ref: 'paths/participants_Type_ID.yaml'
+  /participants/{Type}/{ID}/error:
+    $ref: 'paths/participants_Type_ID_error.yaml'
+  /participants/{Type}/{ID}/{SubId}:
+    $ref: 'paths/participants_Type_ID_SubId.yaml'
+  /participants/{Type}/{ID}/{SubId}/error:
+    $ref: 'paths/participants_Type_ID_SubId_error.yaml'
+  /participants:
+    $ref: 'paths/participants.yaml'
+  /participants/{ID}:
+    $ref: 'paths/participants_ID.yaml'
+  /participants/{ID}/error:
+    $ref: 'paths/participants_ID_error.yaml'
+  /parties/{Type}/{ID}:
+    $ref: 'paths/parties_Type_ID.yaml'
+  /parties/{Type}/{ID}/error:
+    $ref: 'paths/parties_Type_ID_error.yaml'
+  /parties/{Type}/{ID}/{SubId}:
+    $ref: 'paths/parties_Type_ID_SubId.yaml'
+  /parties/{Type}/{ID}/{SubId}/error:
+    $ref: 'paths/parties_Type_ID_SubId_error.yaml'
+  /transactionRequests:
+    $ref: 'paths/transactionRequests.yaml'
+  /transactionRequests/{ID}:
+    $ref: 'paths/transactionRequests_ID.yaml'
+  /transactionRequests/{ID}/error:
+    $ref: 'paths/transactionRequests_ID_error.yaml'
+  /quotes:
+    $ref: 'paths/quotes.yaml'
+  /quotes/{ID}:
+    $ref: 'paths/quotes_ID.yaml'
+  /quotes/{ID}/error:
+    $ref: 'paths/quotes_ID_error.yaml'
+  /authorizations/{ID}:
+    $ref: 'paths/authorizations_ID.yaml'
+  /authorizations/{ID}/error:
+    $ref: 'paths/authorizations_ID_error.yaml'
+  /transfers:
+    $ref: 'paths/transfers.yaml'
+  /transfers/{ID}:
+    $ref: 'paths/transfers_ID.yaml'
+  /transfers/{ID}/error:
+    $ref: 'paths/transfers_ID_error.yaml'
+  /transactions/{ID}:
+    $ref: 'paths/transactions_ID.yaml'
+  /transactions/{ID}/error:
+    $ref: 'paths/transactions_ID_error.yaml'
+  /bulkQuotes:
+    $ref: 'paths/bulkQuotes.yaml'
+  /bulkQuotes/{ID}:
+    $ref: 'paths/bulkQuotes_ID.yaml'
+  /bulkQuotes/{ID}/error:
+    $ref: 'paths/bulkQuotes_ID_error.yaml'
+  /bulkTransfers:
+    $ref: 'paths/bulkTransfers.yaml'
+  /bulkTransfers/{ID}:
+    $ref: 'paths/bulkTransfers_ID.yaml'
+  /bulkTransfers/{ID}/error:
+    $ref: 'paths/bulkTransfers_ID_error.yaml'
+  /fxQuotes:
+    $ref: 'paths/fxQuotes.yaml'
+  /fxQuotes/{ID}:
+    $ref: 'paths/fxQuotes_ID.yaml'
+  /fxQuotes/{ID}/error:
+    $ref: 'paths/fxQuotes_ID_error.yaml'
+  /fxTransfers:
+    $ref: 'paths/fxTransfers.yaml'
+  /fxTransfers/{ID}:
+    $ref: 'paths/fxTransfers_ID.yaml'
+  /fxTransfers/{ID}/error:
+    $ref: 'paths/fxTransfers_ID_error.yaml'
+  /services/FXP:
+    $ref: 'paths/services_FXP.yaml'
+  /services/FXP/{SourceCurrency}/{TargetCurrency}:
+    $ref: 'paths/services_FXP_SourceCurrency_TargetCurrency.yaml'

package/fspiop/v2_0/openapi3/paths/authorizations_ID.yaml

@@ -0,0 +1,110 @@
+parameters:
+  - $ref: ../components/parameters/ID.yaml
+  - $ref: ../components/parameters/Content-Type.yaml
+  - $ref: ../components/parameters/Date.yaml
+  - $ref: ../components/parameters/X-Forwarded-For.yaml
+  - $ref: ../components/parameters/FSPIOP-Source.yaml
+  - $ref: ../components/parameters/FSPIOP-Destination.yaml
+  - $ref: ../components/parameters/FSPIOP-Encryption.yaml
+  - $ref: ../components/parameters/FSPIOP-Signature.yaml
+  - $ref: ../components/parameters/FSPIOP-URI.yaml
+  - $ref: ../components/parameters/FSPIOP-HTTP-Method.yaml
+get:
+  description: >-
+    The HTTP request `GET /authorizations/{ID}` is used to request the Payer to
+    enter the applicable credentials in the Payee FSP system. The `{ID}` in the
+    URI should contain the `transactionRequestID`, received from the `POST
+    /transactionRequests` service earlier in the process. This request requires
+    a query string to be included in the URI, with the following key-value
+    pairs*:*
+
+
+    - `authenticationType={Type}`, where `{Type}` value is a valid
+    authentication type from the enumeration `AuthenticationType`.
+
+
+    - `retriesLeft=={NrOfRetries}`, where `{NrOfRetries}` is the number of
+    retries left before the financial transaction is rejected. `{NrOfRetries}`
+    must be expressed in the form of the data type `Integer`. `retriesLeft=1`
+    means that this is the last retry before the financial transaction is
+    rejected.
+
+
+    - `amount={Amount}`, where `{Amount}` is the transaction amount that will be
+    withdrawn from the Payer’s account. `{Amount}` must be expressed in the form
+    of the data type `Amount`.
+
+
+    - `currency={Currency}`, where `{Currency}` is the transaction currency for
+    the amount that will be withdrawn from the Payer’s account. The `{Currency}`
+    value must be expressed in the form of the enumeration `CurrencyCode`.
+
+
+    The following is an example URI containing all the required key-value pairs
+    in the query string*:*
+
+
+    `GET
+    /authorization/3d492671-b7af-4f3f-88de-76169b1bdf88?authenticationType=OTP&retriesLeft=2&amount=102&currency=USD`
+  summary: Perform authorization
+  tags:
+    - authorizations
+  operationId: AuthorizationsByIDGet
+  parameters:
+    - $ref: ../components/parameters/Accept.yaml
+  responses:
+    '202':
+      $ref: ../components/responses/202.yaml
+    '400':
+      $ref: ../components/responses/400.yaml
+    '401':
+      $ref: ../components/responses/401.yaml
+    '403':
+      $ref: ../components/responses/403.yaml
+    '404':
+      $ref: ../components/responses/404.yaml
+    '405':
+      $ref: ../components/responses/405.yaml
+    '406':
+      $ref: ../components/responses/406.yaml
+    '501':
+      $ref: ../components/responses/501.yaml
+    '503':
+      $ref: ../components/responses/503.yaml
+put:
+  description: >-
+    The callback `PUT /authorizations/{ID}` is used to inform the client of the
+    result of a previously-requested authorization. The `{ID}` in the URI should
+    contain the `{ID}` that was used in the `GET /authorizations/{ID}` request.
+  summary: Return authorization result
+  tags:
+    - authorizations
+  operationId: AuthorizationsByIDPut
+  parameters:
+    - $ref: ../components/parameters/Content-Length.yaml
+  requestBody:
+    description: Authorization result returned.
+    required: true
+    content:
+      application/json:
+        schema:
+          $ref: ../components/schemas/AuthorizationsIDPutResponse.yaml
+  responses:
+    '200':
+      $ref: ../components/responses/200.yaml
+    '400':
+      $ref: ../components/responses/400.yaml
+    '401':
+      $ref: ../components/responses/401.yaml
+    '403':
+      $ref: ../components/responses/403.yaml
+    '404':
+      $ref: ../components/responses/404.yaml
+    '405':
+      $ref: ../components/responses/405.yaml
+    '406':
+      $ref: ../components/responses/406.yaml
+    '501':
+      $ref: ../components/responses/501.yaml
+    '503':
+      $ref: ../components/responses/503.yaml

package/fspiop/v2_0/openapi3/paths/authorizations_ID_error.yaml

@@ -0,0 +1,48 @@
+put:
+  description: >-
+    If the server is unable to find the transaction request, or another
+    processing error occurs, the error callback `PUT /authorizations/{ID}/error`
+    is used. The `{ID}` in the URI should contain the `{ID}` that was used in
+    the `GET /authorizations/{ID}`.
+  summary: Return authorization error
+  tags:
+    - authorizations
+  operationId: AuthorizationsByIDAndError
+  parameters:
+    - $ref: ../components/parameters/ID.yaml
+    - $ref: ../components/parameters/Content-Length.yaml
+    - $ref: ../components/parameters/Content-Type.yaml
+    - $ref: ../components/parameters/Date.yaml
+    - $ref: ../components/parameters/X-Forwarded-For.yaml
+    - $ref: ../components/parameters/FSPIOP-Source.yaml
+    - $ref: ../components/parameters/FSPIOP-Destination.yaml
+    - $ref: ../components/parameters/FSPIOP-Encryption.yaml
+    - $ref: ../components/parameters/FSPIOP-Signature.yaml
+    - $ref: ../components/parameters/FSPIOP-URI.yaml
+    - $ref: ../components/parameters/FSPIOP-HTTP-Method.yaml
+  requestBody:
+    description: Details of the error returned.
+    required: true
+    content:
+      application/json:
+        schema:
+          $ref: ../components/schemas/ErrorInformationObject.yaml
+  responses:
+    '200':
+      $ref: ../components/responses/200.yaml
+    '400':
+      $ref: ../components/responses/400.yaml
+    '401':
+      $ref: ../components/responses/401.yaml
+    '403':
+      $ref: ../components/responses/403.yaml
+    '404':
+      $ref: ../components/responses/404.yaml
+    '405':
+      $ref: ../components/responses/405.yaml
+    '406':
+      $ref: ../components/responses/406.yaml
+    '501':
+      $ref: ../components/responses/501.yaml
+    '503':
+      $ref: ../components/responses/503.yaml

package/fspiop/v2_0/openapi3/paths/bulkQuotes.yaml

@@ -0,0 +1,46 @@
+post:
+  description: >-
+    The HTTP request `POST /bulkQuotes` is used to request the creation of a
+    bulk quote for the provided financial transactions in the server.
+  summary: Calculate bulk quote
+  tags:
+    - bulkQuotes
+  operationId: BulkQuotes
+  parameters:
+    - $ref: ../components/parameters/Accept.yaml
+    - $ref: ../components/parameters/Content-Length.yaml
+    - $ref: ../components/parameters/Content-Type.yaml
+    - $ref: ../components/parameters/Date.yaml
+    - $ref: ../components/parameters/X-Forwarded-For.yaml
+    - $ref: ../components/parameters/FSPIOP-Source.yaml
+    - $ref: ../components/parameters/FSPIOP-Destination.yaml
+    - $ref: ../components/parameters/FSPIOP-Encryption.yaml
+    - $ref: ../components/parameters/FSPIOP-Signature.yaml
+    - $ref: ../components/parameters/FSPIOP-URI.yaml
+    - $ref: ../components/parameters/FSPIOP-HTTP-Method.yaml
+  requestBody:
+    description: Details of the bulk quote to be created.
+    required: true
+    content:
+      application/json:
+        schema:
+          $ref: ../components/schemas/BulkQuotesPostRequest.yaml
+  responses:
+    '202':
+      $ref: ../components/responses/202.yaml
+    '400':
+      $ref: ../components/responses/400.yaml
+    '401':
+      $ref: ../components/responses/401.yaml
+    '403':
+      $ref: ../components/responses/403.yaml
+    '404':
+      $ref: ../components/responses/404.yaml
+    '405':
+      $ref: ../components/responses/405.yaml
+    '406':
+      $ref: ../components/responses/406.yaml
+    '501':
+      $ref: ../components/responses/501.yaml
+    '503':
+      $ref: ../components/responses/503.yaml