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

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

@@ -0,0 +1,54 @@
+title: PartyIdType
+type: string
+enum:
+  - MSISDN
+  - EMAIL
+  - PERSONAL_ID
+  - BUSINESS
+  - DEVICE
+  - ACCOUNT_ID
+  - IBAN
+  - ALIAS
+description: >-
+  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.

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

@@ -0,0 +1,6 @@
+title: PartyIdentifier
+type: string
+minLength: 1
+maxLength: 128
+description: Identifier of the Party.
+example: '16135551212'

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

@@ -0,0 +1,5 @@
+title: PartyName
+type: string
+minLength: 1
+maxLength: 128
+description: Name of the Party. Could be a real name or a nickname.

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

@@ -0,0 +1,8 @@
+title: PartyPersonalInfo
+type: object
+description: Data model for the complex type PartyPersonalInfo.
+properties:
+  complexName:
+    $ref: ./PartyComplexName.yaml
+  dateOfBirth:
+    $ref: ./DateOfBirth.yaml

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

@@ -0,0 +1,7 @@
+title: PartySubIdOrType
+type: string
+minLength: 1
+maxLength: 128
+description: >-
+  Either a sub-identifier of a PartyIdentifier, or a sub-type of the
+  PartyIdType, normally a PersonalIdentifierType.

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

@@ -0,0 +1,27 @@
+title: QuotesIDPutResponse
+type: object
+description: The object sent in the PUT /quotes/{ID} callback.
+properties:
+  transferAmount:
+    $ref: ./Money.yaml
+  payeeReceiveAmount:
+    $ref: ./Money.yaml
+  payeeFspFee:
+    $ref: ./Money.yaml
+  payeeFspCommission:
+    $ref: ./Money.yaml
+  expiration:
+    $ref: ./DateTime.yaml
+  geoCode:
+    $ref: ./GeoCode.yaml
+  ilpPacket:
+    $ref: ./IlpPacket.yaml
+  condition:
+    $ref: ./IlpCondition.yaml
+  extensionList:
+    $ref: ./ExtensionList.yaml
+required:
+  - transferAmount
+  - expiration
+  - ilpPacket
+  - condition

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

@@ -0,0 +1,53 @@
+title: QuotesPostRequest
+type: object
+description: The object sent in the POST /quotes request.
+properties:
+  quoteId:
+    $ref: ./CorrelationId.yaml
+  transactionId:
+    $ref: ./CorrelationId.yaml
+  transactionRequestId:
+    $ref: ./CorrelationId.yaml
+  payee:
+    $ref: ./Party.yaml
+  payer:
+    $ref: ./Party.yaml
+  amountType:
+    $ref: ./AmountType.yaml
+  amount:
+    $ref: ./Money.yaml
+  fees:
+    $ref: ./Money.yaml
+  transactionType:
+    $ref: ./TransactionType.yaml
+  converter:
+      allOf:
+        - $ref: ../../../../fspiop/v2_0/openapi3/components/schemas/CurrencyConverter.yaml
+        - description: >-
+            An optional field which will allow the payer DFSP to specify which DFSP it wants to undertake currency conversion.
+            This is useful incase of if the sender wants the recipient to receive a specified amount of the target currency,
+            but the payer DFSP does not want to undertake the currency conversion. In this case, the amount of the transfer
+            would be expressed in the target currency and the amountType would be set to RECEIVE.
+  currencyConversion:
+    allOf:
+      - $ref: ../../../../fspiop/v2_0/openapi3/components/schemas/FxRate.yaml
+      - description: >-
+          Used by the debtor party if it wants to share information about the currency conversion it proposes to make; or
+          if it is required by scheme rules to share this information. This object contains the amount of the transfer in
+          the source and target currencies, but does not identify the FXP being used.
+  geoCode:
+    $ref: ./GeoCode.yaml
+  note:
+    $ref: ./Note.yaml
+  expiration:
+    $ref: ./DateTime.yaml
+  extensionList:
+    $ref: ./ExtensionList.yaml
+required:
+  - quoteId
+  - transactionId
+  - payee
+  - payer
+  - amountType
+  - amount
+  - transactionType

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

@@ -0,0 +1,10 @@
+title: Refund
+type: object
+description: Data model for the complex type Refund.
+properties:
+  originalTransactionId:
+    $ref: ./CorrelationId.yaml
+  refundReason:
+    $ref: ./RefundReason.yaml
+required:
+  - originalTransactionId

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

@@ -0,0 +1,6 @@
+title: RefundReason
+type: string
+minLength: 1
+maxLength: 128
+description: Reason for the refund.
+example: Free text indicating reason for the refund.

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

@@ -0,0 +1,16 @@
+title: TransactionInitiator
+type: string
+enum:
+  - PAYER
+  - PAYEE
+description: >-
+  Below are the allowed values for the enumeration.
+
+  - PAYER - Sender of funds is initiating the transaction. The account to send
+  from is either owned by the Payer or is connected to the Payer in some way.
+
+  - PAYEE - Recipient of the funds is initiating the transaction by sending a
+  transaction request. The Payer must approve the transaction, either
+  automatically by a pre-generated OTP or by pre-approval of the Payee, or by
+  manually approving in his or her own Device.
+example: PAYEE

package/sdk-scheme-adapter/v2_1_0/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/sdk-scheme-adapter/v2_1_0/components/schemas/TransactionRequestResponse.yaml

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

package/sdk-scheme-adapter/v2_1_0/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/sdk-scheme-adapter/v2_1_0/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/sdk-scheme-adapter/v2_1_0/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/sdk-scheme-adapter/v2_1_0/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/sdk-scheme-adapter/v2_1_0/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/sdk-scheme-adapter/v2_1_0/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/sdk-scheme-adapter/v2_1_0/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/sdk-scheme-adapter/v2_1_0/components/schemas/accountCreationStatus.yaml

@@ -0,0 +1,15 @@
+type: array
+items:
+  type: object
+  required:
+    - idType
+    - idValue
+  properties:
+    idType:
+      $ref: ./PartyIdType.yaml
+    idValue:
+      $ref: ./PartyIdentifier.yaml
+    idSubValue:
+      $ref: ./PartySubIdOrType.yaml
+    error:
+      $ref: ./errorResponse.yaml

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

@@ -0,0 +1,4 @@
+type: string
+enum:
+  - ERROR_OCCURRED
+  - COMPLETED

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

@@ -0,0 +1,16 @@
+type: array
+items:
+  type: object
+  required:
+    - idType
+    - idValue
+    - currency
+  properties:
+    idType:
+      $ref: ./PartyIdType.yaml
+    idValue:
+      $ref: ./PartyIdentifier.yaml
+    idSubValue:
+      $ref: ./PartySubIdOrType.yaml
+    currency:
+      $ref: ./Currency.yaml

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

@@ -0,0 +1,23 @@
+type: object
+required:
+  - accounts
+properties:
+  modelId:
+    $ref: ./CorrelationId.yaml
+  accounts:
+    $ref: ./accountsRequest.yaml
+  response:
+    $ref: ./accountCreationStatus.yaml
+  currentState:
+    $ref: ./accountsCreationState.yaml
+  lastError:
+    $ref: ./transferError.yaml
+  postAccountsResponse:
+    type: object
+    required:
+      - body
+    properties:
+      body:
+        type: object
+      headers:
+        type: object

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

@@ -0,0 +1,5 @@
+type: string
+enum:
+  - WAITING_FOR_ACTION
+  - COMPLETED
+  - ERROR_OCCURRED

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

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

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

@@ -0,0 +1,14 @@
+type: object
+required:
+  - enabled
+properties:
+  enabled:
+    type: boolean
+    enum:
+      - true
+      - false
+  perTransferFeeLimits:
+    type: array
+    minItems: 0
+    items:
+      $ref: ./bulkPerTransferFeeLimit.yaml

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

@@ -0,0 +1,9 @@
+type: object
+required:
+  - currency
+  - amount
+properties:
+  currency:
+    $ref: ./Currency.yaml
+  amount:
+    $ref: ./Amount.yaml

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

@@ -0,0 +1,8 @@
+allOf:
+  - $ref: ./errorResponse.yaml
+  - type: object
+    required:
+      - bulkQuoteState
+    properties:
+      bulkQuoteState:
+        $ref: ./bulkQuoteResponse.yaml

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

@@ -0,0 +1,24 @@
+type: object
+required:
+  - homeTransactionId
+  - from
+  - individualQuotes
+properties:
+  homeTransactionId:
+    type: string
+    description: >-
+      Transaction ID from the DFSP backend, used to reconcile transactions
+      between the Switch and DFSP backend systems.
+  bulkQuoteId:
+    $ref: ./CorrelationId.yaml
+  from:
+    $ref: ./transferParty.yaml
+  individualQuotes:
+    description: List of individual quotes in a bulk quote.
+    type: array
+    minItems: 1
+    maxItems: 1000
+    items:
+      $ref: ./individualQuote.yaml
+  extensions:
+    $ref: ./ExtensionList.yaml

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

@@ -0,0 +1,26 @@
+type: object
+required:
+  - bulkQuoteId
+  - individualQuoteResults
+  - currentState
+  - expiration
+properties:
+  bulkQuoteId:
+    $ref: ./CorrelationId.yaml
+  homeTransactionId:
+    type: string
+    description: >-
+      Transaction ID from the DFSP backend, used to reconcile transactions
+      between the Switch and DFSP backend systems.
+  expiration:
+    $ref: ./DateTime.yaml
+  extensionList:
+    $ref: ./ExtensionList.yaml
+  currentState:
+    $ref: ../schemas/bulkTransferStatus.yaml
+  individualQuoteResults:
+    type: array
+    maxItems: 1000
+    items:
+      $ref: ./individualQuoteResult.yaml
+    description: List of individualQuoteResults in a bulk transfer response.

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

@@ -0,0 +1,4 @@
+type: string
+enum:
+  - ERROR_OCCURRED
+  - COMPLETED

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

@@ -0,0 +1,16 @@
+type: object
+required:
+  - bulkQuoteId
+  - currentState
+  - individualQuotes
+properties:
+  bulkQuoteId:
+    $ref: ./CorrelationId.yaml
+  currentState:
+    $ref: ./bulkQuoteStatus.yaml
+  individualQuotes:
+    type: array
+    minItems: 1
+    maxItems: 1000
+    items:
+      $ref: ./individualQuote.yaml

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

@@ -0,0 +1,10 @@
+allOf:
+  - $ref: ./errorResponse.yaml
+  - type: object
+    required:
+      - bulkTransferState
+    properties:
+      bulkTransferState:
+        allOf:
+          - $ref: ./bulkTransactionContinuationAcceptParty.yaml
+          - $ref: ./partyError.yaml

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

@@ -0,0 +1,10 @@
+allOf:
+  - $ref: ./errorResponse.yaml
+  - type: object
+    required:
+      - bulkTansferState
+    properties:
+      bulkTransferState:
+        allOf:
+          - $ref: ./bulkTransactionContinuationAcceptQuote.yaml
+          - $ref: ./quoteError.yaml

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

@@ -0,0 +1,17 @@
+description: >-
+  The object sent back as confirmation of payee parties when autoAcceptParty is
+  false.
+type: object
+required:
+  - individualTransfers
+properties:
+  individualTransfers:
+    description: >-
+      List of individual transfers in a bulk transfer with accept party
+      information.
+    type: array
+    minItems: 1
+    items:
+      allOf:
+        - $ref: ./bulkTransactionIndividualTransferAccept.yaml
+        - $ref: ./transferContinuationAcceptParty.yaml

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

@@ -0,0 +1,13 @@
+description: The object sent back as confirmation of quotes when autoAcceptQuotes is false.
+type: object
+required:
+  - individualTransfers
+properties:
+  individualTransfers:
+    description: List of individual transfers in a bulk transfer.
+    type: array
+    minItems: 1
+    items:
+      allOf:
+        - $ref: ./bulkTransactionIndividualTransferAccept.yaml
+        - $ref: ./transferContinuationAcceptQuote.yaml

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

@@ -0,0 +1,34 @@
+title: BulkTransactionIndividualTransfer
+type: object
+description: Data model for the complex type 'bulkTransactionIndividualTransfer'.
+properties:
+  homeTransactionId:
+    type: string
+    description: >-
+      Transaction ID from the DFSP backend, used to reconcile transactions
+      between the Switch and DFSP backend systems.
+  to:
+    $ref: ./Party.yaml
+  reference:
+    description: Payer Loan reference
+    type: string
+  amountType:
+    $ref: ./AmountType.yaml
+  currency:
+    $ref: ./Currency.yaml
+  amount:
+    $ref: ./Amount.yaml
+  note:
+    $ref: ./Note.yaml
+  quoteExtensions:
+    $ref: ./ExtensionList.yaml
+  transferExtensions:
+    $ref: ./ExtensionList.yaml
+  lastError:
+    $ref: ./transferError.yaml
+required:
+  - homeTransactionId
+  - to
+  - amountType
+  - currency
+  - amount