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

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

@@ -0,0 +1,18 @@
+title: BulkQuotesIDPutResponse
+type: object
+description: 'The object sent in the PUT /bulkQuotes/{ID} callback.'
+properties:
+  individualQuoteResults:
+    type: array
+    maxItems: 1000
+    items:
+      $ref: ./IndividualQuoteResult.yaml
+    description: >-
+      Fees for each individual transaction, if any of them are charged per
+      transaction.
+  expiration:
+    $ref: ./DateTime.yaml
+  extensionList:
+    $ref: ./ExtensionList.yaml
+required:
+  - expiration

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

@@ -0,0 +1,25 @@
+title: BulkQuotesPostRequest
+type: object
+description: The object sent in the POST /bulkQuotes request.
+properties:
+  bulkQuoteId:
+    $ref: ./CorrelationId.yaml
+  payer:
+    $ref: ./Party.yaml
+  geoCode:
+    $ref: ./GeoCode.yaml
+  expiration:
+    $ref: ./DateTime.yaml
+  individualQuotes:
+    type: array
+    minItems: 1
+    maxItems: 1000
+    items:
+      $ref: ./IndividualQuote.yaml
+    description: List of quotes elements.
+  extensionList:
+    $ref: ./ExtensionList.yaml
+required:
+  - bulkQuoteId
+  - payer
+  - individualQuotes

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

@@ -0,0 +1,18 @@
+title: BulkTransactionState
+type: string
+enum:
+  - RECEIVED
+  - PENDING
+  - ACCEPTED
+  - PROCESSING
+  - COMPLETED
+  - REJECTED
+description: |-
+  Below are the allowed values for the enumeration.
+  - RECEIVED - Payee FSP has received the bulk transfer from the Payer FSP.
+  - PENDING - Payee FSP has validated the bulk transfer.
+  - ACCEPTED - Payee FSP has accepted to process the bulk transfer.
+  - PROCESSING - Payee FSP has started to transfer fund to the Payees.
+  - COMPLETED - Payee FSP has completed transfer of funds to the Payees.
+  - REJECTED - Payee FSP has rejected to process the bulk transfer.
+example: 'RECEIVED'

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

@@ -0,0 +1,18 @@
+title: BulkTransfersIDPutResponse
+type: object
+description: 'The object sent in the PUT /bulkTransfers/{ID} callback.'
+properties:
+  completedTimestamp:
+    $ref: ./DateTime.yaml
+  individualTransferResults:
+    type: array
+    maxItems: 1000
+    items:
+      $ref: ./IndividualTransferResult.yaml
+    description: List of IndividualTransferResult elements.
+  bulkTransferState:
+    $ref: ./BulkTransferState.yaml
+  extensionList:
+    $ref: ./ExtensionList.yaml
+required:
+  - bulkTransferState

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

@@ -0,0 +1,30 @@
+title: BulkTransfersPostRequest
+type: object
+description: The object sent in the POST /bulkTransfers request.
+properties:
+  bulkTransferId:
+    $ref: ./CorrelationId.yaml
+  bulkQuoteId:
+    $ref: ./CorrelationId.yaml
+  payerFsp:
+    $ref: ./FspId.yaml
+  payeeFsp:
+    $ref: ./FspId.yaml
+  individualTransfers:
+    type: array
+    minItems: 1
+    maxItems: 1000
+    items:
+      $ref: ./IndividualTransfer.yaml
+    description: List of IndividualTransfer elements.
+  expiration:
+    $ref: ./DateTime.yaml
+  extensionList:
+    $ref: ./ExtensionList.yaml
+required:
+  - bulkTransferId
+  - bulkQuoteId
+  - payerFsp
+  - payeeFsp
+  - individualTransfers
+  - expiration

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

@@ -0,0 +1,5 @@
+title: Code
+type: string
+pattern: '^[0-9a-zA-Z]{4,32}$'
+description: Any code/token returned by the Payee FSP (TokenCode Type).
+example: 'Test-Code'

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

@@ -0,0 +1,10 @@
+title: CorrelationId
+type: string
+pattern: '^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$'
+description: >-
+  Identifier that correlates all messages of the same sequence. The API data
+  type UUID (Universally Unique Identifier) is a JSON String in canonical
+  format, conforming to [RFC 4122](https://tools.ietf.org/html/rfc4122), that is
+  restricted by a regular expression for interoperability reasons. A UUID is
+  always 36 characters long, 32 hexadecimal symbols and 4 dashes (‘-‘).
+example: 'b51ec534-ee48-4575-b6a9-ead2955b8069'

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

@@ -0,0 +1,174 @@
+title: Currency
+description: >-
+  The currency codes defined in [ISO
+  4217](https://www.iso.org/iso-4217-currency-codes.html) as three-letter
+  alphabetic codes are used as the standard naming representation for
+  currencies.
+type: string
+minLength: 3
+maxLength: 3
+enum:
+  - 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

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

@@ -0,0 +1,9 @@
+title: CurrencyConverter
+type: string
+enum:
+  - PAYER
+  - PAYEE
+description: >-
+  Below are the allowed values for the enumeration CurrencyConverter.
+  - PAYER - Currency conversion should be performed by the payer.
+  - PAYEE - Currency conversion should be performed by the payee.

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

@@ -0,0 +1,9 @@
+title: Date
+type: string
+pattern: >-
+  ^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)$
+description: >-
+  The API data type Date is a JSON String in a lexical format that is restricted
+  by a regular expression for interoperability reasons. This format, as
+  specified in ISO 8601, contains a date only. A more readable version of the
+  format is yyyy-MM-dd. Examples are "1982-05-23", "1987-08-05”.

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

@@ -0,0 +1,6 @@
+title: DateofBirth (type Date)
+type: string
+pattern: >-
+  ^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)$
+description: Date of Birth of the Party.
+example: '1966-06-16'

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

@@ -0,0 +1,14 @@
+title: DateTime
+type: string
+pattern: >-
+  ^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:(\.\d{3}))(?:Z|[+-][01]\d:[0-5]\d)$
+description: >-
+  The API data type DateTime is a JSON String in a lexical format that is
+  restricted by a regular expression for interoperability reasons. The format is
+  according to [ISO
+  8601](https://www.iso.org/iso-8601-date-and-time-format.html), expressed in a
+  combined date, time and time zone format. A more readable version of the
+  format is yyyy-MM-ddTHH:mm:ss.SSS[-HH:MM]. Examples are
+  "2016-05-24T08:38:08.699-04:00", "2016-05-24T08:38:08.699Z" (where Z indicates
+  Zulu time zone, same as UTC).
+example: '2016-05-24T08:38:08.699-04:00'

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

@@ -0,0 +1,11 @@
+title: ErrorCode
+type: string
+pattern: '^[1-9]\d{3}$'
+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) represent the specific error.
+example: '5100'

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

@@ -0,0 +1,5 @@
+title: ErrorDescription
+type: string
+minLength: 1
+maxLength: 128
+description: Error description string.

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

@@ -0,0 +1,13 @@
+title: ErrorInformation
+type: object
+description: Data model for the complex type ErrorInformation.
+properties:
+  errorCode:
+    $ref: ./ErrorCode.yaml
+  errorDescription:
+    $ref: ./ErrorDescription.yaml
+  extensionList:
+    $ref: ./ExtensionList.yaml
+required:
+  - errorCode
+  - errorDescription

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

@@ -0,0 +1,8 @@
+title: ErrorInformationObject
+type: object
+description: Data model for the complex type object that contains ErrorInformation.
+properties:
+  errorInformation:
+    $ref: ./ErrorInformation.yaml
+required:
+  - errorInformation

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

@@ -0,0 +1,8 @@
+title: ErrorInformationResponse
+type: object
+description: >-
+  Data model for the complex type object that contains an optional element
+  ErrorInformation used along with 4xx and 5xx responses.
+properties:
+  errorInformation:
+    $ref: ./ErrorInformation.yaml

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

@@ -0,0 +1,11 @@
+title: Extension
+type: object
+description: Data model for the complex type Extension.
+properties:
+  key:
+    $ref: ./ExtensionKey.yaml
+  value:
+    $ref: ./ExtensionValue.yaml
+required:
+  - key
+  - value

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

@@ -0,0 +1,5 @@
+title: ExtensionKey
+type: string
+minLength: 1
+maxLength: 32
+description: Extension key.

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

@@ -0,0 +1,15 @@
+title: ExtensionList
+type: object
+description: >-
+  Data model for the complex type ExtensionList. An optional list of extensions,
+  specific to deployment.
+properties:
+  extension:
+    type: array
+    items:
+      $ref: ./Extension.yaml
+    minItems: 1
+    maxItems: 16
+    description: Number of Extension elements.
+required:
+  - extension

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

@@ -0,0 +1,5 @@
+title: ExtensionValue
+type: string
+minLength: 1
+maxLength: 128
+description: Extension value.

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

@@ -0,0 +1,9 @@
+title: FirstName
+type: string
+minLength: 1
+maxLength: 128
+pattern: >-
+  ^(?!\s*$)[\p{L}\p{gc=Mark}\p{digit}\p{gc=Connector_Punctuation}\p{Join_Control}
+  .,''-]{1,128}$
+description: First name of the Party (Name Type).
+example: 'Henrik'

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

@@ -0,0 +1,5 @@
+title: FspId
+type: string
+minLength: 1
+maxLength: 32
+description: FSP identifier.

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

@@ -0,0 +1,19 @@
+title: FxCharge
+type: object
+description: An FXP will be able to specify a charge which it proposes to levy on the currency conversion operation using a FxCharge object.
+properties:
+  chargeType:
+    type: string
+    minLength: 1
+    maxLength: 32
+    description: A description of the charge which is being levied.
+  sourceAmount:
+    allOf:
+      - $ref: ./Money.yaml
+      - description: The amount of the charge which is being levied, expressed in the source currency.
+  targetAmount:
+    allOf:
+      - $ref: ./Money.yaml
+      - description: The amount of the charge which is being levied, expressed in the target currency.
+required:
+  - chargeType

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

@@ -0,0 +1,57 @@
+title: FxConversion
+type: object
+description: A DFSP will be able to request a currency conversion, and an FX provider will be able to describe its involvement in a proposed transfer, using a FxConversion object.
+properties:
+  conversionId:
+    allOf:
+      - $ref: ./CorrelationId.yaml
+      - description: An end-to-end identifier for the conversion request.
+  determiningTransferId:
+    allOf:
+      - $ref: ./CorrelationId.yaml
+      - description: The transaction ID of the transfer on whose success this currency conversion depends.
+  initiatingFsp:
+    allOf:
+      - $ref: ./FspId.yaml
+      - description: The id of the participant who is requesting a currency conversion.
+  counterPartyFsp:
+    allOf:
+      - $ref: ./FspId.yaml
+      - description: The ID of the FXP performing the conversion.
+  amountType:
+    allOf:
+      - $ref: ./AmountType.yaml
+      - description: This is the AmountType for the base transaction -
+          If SEND - then any charges levied by the FXP as part of the transaction will be deducted by the FXP from the amount shown for the target party in the conversion.
+          If RECEIVE - then any charges levied by the FXP as part of the transaction will be added by the FXP to the amount shown for the source party in the conversion.
+  sourceAmount:
+    allOf:
+      - $ref: ./FxMoney.yaml
+      - description: The amount to be converted, expressed in the source currency.
+  targetAmount:
+    allOf:
+      - $ref: ./FxMoney.yaml
+      - description: The converted amount, expressed in the target currency.
+  expiration:
+    allOf:
+      - $ref: ./DateTime.yaml
+      - description: The end of the period for which the currency conversion is required to remain valid.
+  charges:
+    type: array
+    description: One or more charges which the FXP intends to levy as part of the currency conversion, or which the payee DFSP intends to add to the amount transferred.
+    items:
+      $ref: ./FxCharge.yaml
+    minItems: 0
+    maxItems: 16
+  extensionList:
+    allOf:
+      - $ref: ./ExtensionList.yaml
+      - description: The extension list for the currency conversion request.
+required:
+  - conversionId
+  - initiatingFsp
+  - counterPartyFsp
+  - amountType
+  - sourceAmount
+  - targetAmount
+  - expiration

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

@@ -0,0 +1,10 @@
+title: FxMoney
+type: object
+description: Data model for the complex type FxMoney; This is based on the type Money but allows the amount to be optional to support FX quotations.
+properties:
+  currency:
+    $ref: ./Currency.yaml
+  amount:
+    $ref: ./Amount.yaml
+required:
+  - currency

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

@@ -0,0 +1,15 @@
+title: FxQuotesIDPutResponse
+type: object
+description: The object sent in the PUT /fxQuotes/{ID} callback.
+properties:
+  condition:
+    allOf:
+      - $ref: ./IlpCondition.yaml
+      - description: The ILP condition for the conversion.
+  conversionTerms:
+    allOf:
+      - $ref: ./FxConversion.yaml
+      - description: The terms under which the FXP will undertake the currency conversion proposed by the requester.
+
+required:
+  - conversionTerms

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

@@ -0,0 +1,15 @@
+title: FxQuotesPostRequest
+type: object
+description: The object sent in the POST /fxQuotes request.
+properties:
+  conversionRequestId:
+    allOf:
+      - $ref: ./CorrelationId.yaml
+      - description: An end-to-end identifier for the conversion quotation request.
+  conversionTerms:
+    allOf:
+      - $ref: ./FxConversion.yaml
+      - description: The terms of the currency conversion for which a quotation is sought.
+required:
+  - conversionRequestId
+  - conversionTerms

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

@@ -0,0 +1,15 @@
+title: FxRate
+type: object
+description: The FxRate object contains information about a currency conversion in the transfer. It can be used by parties to the transfer to exchange information with each other about the exchange rate for the transfer, to ensure that the best rate can be agreed on.
+properties:
+  sourceAmount:
+    allOf:
+      - $ref: ./Money.yaml
+      - description: The amount of the transfer in the source currency.
+  targetAmount:
+    allOf:
+      - $ref: ./Money.yaml
+      - description: The amount of the transfer in the target currency.
+required:
+  - sourceAmount
+  - targetAmount

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

@@ -0,0 +1,16 @@
+title: FxTransfersIDPatchResponse
+type: object
+description: 'PATCH /fxTransfers/{ID} object'
+properties:
+  completedTimestamp:
+    allOf:
+      - $ref: ./DateTime.yaml
+      - description: Time and date when the conversion was executed.
+  conversionState:
+    allOf:
+      - $ref: ./TransferState.yaml
+      - description: The current status of the conversion request.
+  extensionList:
+    $ref: ./ExtensionList.yaml
+required:
+  - conversionState

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

@@ -0,0 +1,20 @@
+title: FxTransfersIDPutResponse
+type: object
+description: 'The object sent in the PUT /fxTransfers/{ID} callback.'
+properties:
+  fulfilment:
+    allOf:
+      - $ref: ./IlpFulfilment.yaml
+      - description: The fulfilment of the condition specified for the currency conversion. Mandatory if the conversion has been executed successfully.
+  completedTimestamp:
+    allOf:
+      - $ref: ./DateTime.yaml
+      - description: Time and date when the conversion was executed.
+  conversionState:
+    allOf:
+      - $ref: ./TransferState.yaml
+      - description: The current status of the conversion request.
+  extensionList:
+    $ref: ./ExtensionList.yaml
+required:
+  - conversionState