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

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

@@ -0,0 +1,41 @@
+title: FxTransfersPostRequest
+type: object
+description: The object sent in the POST /fxTransfers request.
+properties:
+  commitRequestId:
+    allOf:
+      - $ref: ./CorrelationId.yaml
+      - description: An end-to-end identifier for the confirmation request.
+  determiningTransferId:
+    allOf:
+      - $ref: ./CorrelationId.yaml
+      - description: The transaction ID of the transfer to which this currency conversion relates, if the conversion is part of a transfer. If the conversion is a bulk currency purchase, this field should be omitted.
+  initiatingFsp:
+    allOf:
+      - $ref: ./FspId.yaml
+      - description: Identifier for the FSP who is requesting a currency conversion.
+  counterPartyFsp:
+    allOf:
+      - $ref: ./FspId.yaml
+      - description: Identifier for the FXP who is performing the currency conversion.
+  sourceAmount:
+    allOf:
+      - $ref: ./Money.yaml
+      - description: The amount being offered for conversion by the requesting FSP.
+  targetAmount:
+    allOf:
+      - $ref: ./Money.yaml
+      - description: The amount which the FXP is to credit to the requesting FSP in the target currency.
+  condition:
+    allOf:
+      - $ref: ./IlpCondition.yaml
+      - description: ILP condition received by the requesting FSP when the quote was approved.
+  expiration:
+    $ref: ./DateTime.yaml
+required:
+  - commitRequestId
+  - initiatingFsp
+  - counterPartyFsp
+  - sourceAmount
+  - targetAmount
+  - condition

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

@@ -0,0 +1,13 @@
+title: GeoCode
+type: object
+description: >-
+  Data model for the complex type GeoCode. Indicates the geographic location
+  from where the transaction was initiated.
+properties:
+  latitude:
+    $ref: ./Latitude.yaml
+  longitude:
+    $ref: ./Longitude.yaml
+required:
+  - latitude
+  - longitude

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

@@ -0,0 +1,5 @@
+title: IlpCondition
+type: string
+pattern: '^[A-Za-z0-9-_]{43}$'
+maxLength: 48
+description: Condition that must be attached to the transfer by the Payer.

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

@@ -0,0 +1,6 @@
+title: IlpFulfilment
+type: string
+pattern: '^[A-Za-z0-9-_]{43}$'
+maxLength: 48
+description: Fulfilment that must be attached to the transfer by the Payee.
+example: 'WLctttbu2HvTsa1XWvUoGRcQozHsqeu9Ahl2JW9Bsu8'

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

@@ -0,0 +1,7 @@
+title: IlpPacket
+type: string
+pattern: '^[A-Za-z0-9-_]+[=]{0,2}$'
+minLength: 1
+maxLength: 32768
+description: Information for recipient (transport layer information).
+example: 'AYIBgQAAAAAAAASwNGxldmVsb25lLmRmc3AxLm1lci45T2RTOF81MDdqUUZERmZlakgyOVc4bXFmNEpLMHlGTFGCAUBQU0svMS4wCk5vbmNlOiB1SXlweUYzY3pYSXBFdzVVc05TYWh3CkVuY3J5cHRpb246IG5vbmUKUGF5bWVudC1JZDogMTMyMzZhM2ItOGZhOC00MTYzLTg0NDctNGMzZWQzZGE5OGE3CgpDb250ZW50LUxlbmd0aDogMTM1CkNvbnRlbnQtVHlwZTogYXBwbGljYXRpb24vanNvbgpTZW5kZXItSWRlbnRpZmllcjogOTI4MDYzOTEKCiJ7XCJmZWVcIjowLFwidHJhbnNmZXJDb2RlXCI6XCJpbnZvaWNlXCIsXCJkZWJpdE5hbWVcIjpcImFsaWNlIGNvb3BlclwiLFwiY3JlZGl0TmFtZVwiOlwibWVyIGNoYW50XCIsXCJkZWJpdElkZW50aWZpZXJcIjpcIjkyODA2MzkxXCJ9IgA'

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

@@ -0,0 +1,29 @@
+title: IndividualQuote
+type: object
+description: Data model for the complex type IndividualQuote.
+properties:
+  quoteId:
+    $ref: ./CorrelationId.yaml
+  transactionId:
+    $ref: ./CorrelationId.yaml
+  payee:
+    $ref: ./Party.yaml
+  amountType:
+    $ref: ./AmountType.yaml
+  amount:
+    $ref: ./Money.yaml
+  fees:
+    $ref: ./Money.yaml
+  transactionType:
+    $ref: ./TransactionType.yaml
+  note:
+    $ref: ./Note.yaml
+  extensionList:
+    $ref: ./ExtensionList.yaml
+required:
+  - quoteId
+  - transactionId
+  - payee
+  - amountType
+  - amount
+  - transactionType

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

@@ -0,0 +1,26 @@
+title: IndividualQuoteResult
+type: object
+description: Data model for the complex type IndividualQuoteResult.
+properties:
+  quoteId:
+    $ref: ./CorrelationId.yaml
+  payee:
+    $ref: ./Party.yaml
+  transferAmount:
+    $ref: ./Money.yaml
+  payeeReceiveAmount:
+    $ref: ./Money.yaml
+  payeeFspFee:
+    $ref: ./Money.yaml
+  payeeFspCommission:
+    $ref: ./Money.yaml
+  ilpPacket:
+    $ref: ./IlpPacket.yaml
+  condition:
+    $ref: ./IlpCondition.yaml
+  errorInformation:
+    $ref: ./ErrorInformation.yaml
+  extensionList:
+    $ref: ./ExtensionList.yaml
+required:
+  - quoteId

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

@@ -0,0 +1,19 @@
+title: IndividualTransfer
+type: object
+description: Data model for the complex type IndividualTransfer.
+properties:
+  transferId:
+    $ref: ./CorrelationId.yaml
+  transferAmount:
+    $ref: ./Money.yaml
+  ilpPacket:
+    $ref: ./IlpPacket.yaml
+  condition:
+    $ref: ./IlpCondition.yaml
+  extensionList:
+    $ref: ./ExtensionList.yaml
+required:
+  - transferId
+  - transferAmount
+  - ilpPacket
+  - condition

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

@@ -0,0 +1,14 @@
+title: IndividualTransferResult
+type: object
+description: Data model for the complex type IndividualTransferResult.
+properties:
+  transferId:
+    $ref: ./CorrelationId.yaml
+  fulfilment:
+    $ref: ./IlpFulfilment.yaml
+  errorInformation:
+    $ref: ./ErrorInformation.yaml
+  extensionList:
+    $ref: ./ExtensionList.yaml
+required:
+  - transferId

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

@@ -0,0 +1,7 @@
+title: Integer
+type: string
+pattern: '^[1-9]\d*$'
+description: >-
+  The API data type Integer is a JSON String consisting of digits only. Negative
+  numbers and leading zeroes are not allowed. The data type is always limited to
+  a specific number of digits.

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

@@ -0,0 +1,33 @@
+title: KYCInformation
+type: string
+minLength: 1
+maxLength: 2048
+description: KYC information for the party in a form mandated by an individual scheme.
+example: >-
+  {
+      "metadata": {
+          "format": "JSON",
+          "version": "1.0",
+          "description": "Data containing KYC Information"
+      },
+      "data": {
+          "name": "John Doe",
+          "dob": "1980-05-15",
+          "gender": "Male",
+          "address": "123 Main Street, Anytown, USA",
+          "email": "johndoe@example.com",
+          "phone": "+1 555-123-4567",
+          "nationality": "US",
+          "passport_number": "AB1234567",
+          "issue_date": "2010-02-20",
+          "expiry_date": "2025-02-20",
+          "bank_account_number": "1234567890",
+          "bank_name": "Example Bank",
+          "employer": "ABC Company",
+          "occupation": "Software Engineer",
+          "income": "$80,000 per year",
+          "marital_status": "Single",
+          "dependents": 0,
+          "risk_level": "Low"
+      }
+  }

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

@@ -0,0 +1,9 @@
+title: LastName
+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: Last name of the Party (Name Type).
+example: 'Karlsson'

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

@@ -0,0 +1,7 @@
+title: Latitude
+type: string
+pattern: '^(\+|-)?(?:90(?:(?:\.0{1,6})?)|(?:[0-9]|[1-8][0-9])(?:(?:\.[0-9]{1,6})?))$'
+description: >-
+  The API data type Latitude is a JSON String in a lexical format that is
+  restricted by a regular expression for interoperability reasons.
+example: '+45.4215'

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

@@ -0,0 +1,8 @@
+title: Longitude
+type: string
+pattern: >-
+  ^(\+|-)?(?:180(?:(?:\.0{1,6})?)|(?:[0-9]|[1-9][0-9]|1[0-7][0-9])(?:(?:\.[0-9]{1,6})?))$
+description: >-
+  The API data type Longitude is a JSON String in a lexical format that is
+  restricted by a regular expression for interoperability reasons.
+example: '+75.6972'

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

@@ -0,0 +1,7 @@
+title: MerchantClassificationCode
+type: string
+pattern: '^[\d]{1,4}$'
+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.

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

@@ -0,0 +1,9 @@
+title: MiddleName
+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: Middle name of the Party (Name Type).
+example: 'Johannes'

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

@@ -0,0 +1,11 @@
+title: Money
+type: object
+description: Data model for the complex type Money.
+properties:
+  currency:
+    $ref: ./Currency.yaml
+  amount:
+    $ref: ./Amount.yaml
+required:
+  - currency
+  - amount

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

@@ -0,0 +1,17 @@
+title: Name
+type: string
+pattern: '^(?!\s*$)[\w .,''-]{1,128}$'
+description: >-
+  The API data type Name is a JSON String, restricted by a regular expression to
+  avoid characters which are generally not used in a name.
+
+
+  Regular Expression - The regular expression for restricting the Name type is
+  "^(?!\s*$)[\w .,'-]{1,128}$". The restriction does not allow a string
+  consisting of whitespace only, all Unicode characters are allowed, as well as
+  the period (.) (apostrophe (‘), dash (-), comma (,) and space characters ( ).
+
+
+  **Note:** In some programming languages, Unicode support must be specifically
+  enabled. For example, if Java is used, the flag UNICODE_CHARACTER_CLASS must
+  be enabled to allow Unicode characters.

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

@@ -0,0 +1,6 @@
+title: Note
+type: string
+minLength: 1
+maxLength: 128
+description: Memo assigned to transaction.
+example: 'Note sent to Payee.'

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

@@ -0,0 +1,7 @@
+title: OtpValue
+type: string
+pattern: '^\d{3,10}$'
+description: >-
+  The API data type OtpValue is a JSON String of 3 to 10 characters, consisting
+  of digits only. Negative numbers are not allowed. One or more leading zeros
+  are allowed.

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

@@ -0,0 +1,17 @@
+title: ParticipantsIDPutResponse
+type: object
+description: 'The object sent in the PUT /participants/{ID} callback.'
+properties:
+  partyList:
+    type: array
+    items:
+      $ref: ./PartyResult.yaml
+    minItems: 1
+    maxItems: 10000
+    description: >-
+      List of PartyResult elements that were either created or failed to be
+      created.
+  currency:
+    $ref: ./Currency.yaml
+required:
+  - partyList

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

@@ -0,0 +1,20 @@
+title: ParticipantsPostRequest
+type: object
+description: The object sent in the POST /participants request.
+properties:
+  requestId:
+    $ref: ./CorrelationId.yaml
+  partyList:
+    type: array
+    items:
+      $ref: ./PartyIdInfo.yaml
+    minItems: 1
+    maxItems: 10000
+    description: >-
+      List of PartyIdInfo elements that the client would like to update or
+      create FSP information about.
+  currency:
+    $ref: ./Currency.yaml
+required:
+  - requestId
+  - partyList

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

@@ -0,0 +1,8 @@
+title: ParticipantsTypeIDPutResponse
+type: object
+description: >-
+  The object sent in the PUT /participants/{Type}/{ID}/{SubId} and
+  /participants/{Type}/{ID} callbacks.
+properties:
+  fspId:
+    $ref: ./FspId.yaml

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

@@ -0,0 +1,15 @@
+title: ParticipantsTypeIDSubIDPostRequest
+type: object
+description: >-
+  The object sent in the POST /participants/{Type}/{ID}/{SubId} and
+  /participants/{Type}/{ID} requests. An additional optional ExtensionList
+  element has been added as part of v1.1 changes.
+properties:
+  fspId:
+    $ref: ./FspId.yaml
+  currency:
+    $ref: ./Currency.yaml
+  extensionList:
+    $ref: ./ExtensionList.yaml
+required:
+  - fspId

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

@@ -0,0 +1,8 @@
+title: PartiesTypeIDPutResponse
+type: object
+description: 'The object sent in the PUT /parties/{Type}/{ID} callback.'
+properties:
+  party:
+    $ref: ./Party.yaml
+required:
+  - party

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

@@ -0,0 +1,21 @@
+title: Party
+type: object
+description: Data model for the complex type Party.
+properties:
+  partyIdInfo:
+    $ref: ./PartyIdInfo.yaml
+  merchantClassificationCode:
+    $ref: ./MerchantClassificationCode.yaml
+  name:
+    $ref: ./PartyName.yaml
+  personalInfo:
+    $ref: ./PartyPersonalInfo.yaml
+  supportedCurrencies:
+    type: array
+    description: Currencies in which the party can receive funds.
+    items:
+      $ref: ./Currency.yaml
+    minItems: 0
+    maxItems: 16
+required:
+  - partyIdInfo

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

@@ -0,0 +1,10 @@
+title: PartyComplexName
+type: object
+description: Data model for the complex type PartyComplexName.
+properties:
+  firstName:
+    $ref: ./FirstName.yaml
+  middleName:
+    $ref: ./MiddleName.yaml
+  lastName:
+    $ref: ./LastName.yaml

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

@@ -0,0 +1,19 @@
+title: PartyIdInfo
+type: object
+description: >-
+  Data model for the complex type PartyIdInfo. An ExtensionList element has been
+  added to this reqeust in version v1.1
+properties:
+  partyIdType:
+    $ref: ./PartyIdType.yaml
+  partyIdentifier:
+    $ref: ./PartyIdentifier.yaml
+  partySubIdOrType:
+    $ref: ./PartySubIdOrType.yaml
+  fspId:
+    $ref: ./FspId.yaml
+  extensionList:
+    $ref: ./ExtensionList.yaml
+required:
+  - partyIdType
+  - partyIdentifier

package/fspiop/v2_0/openapi3/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/fspiop/v2_0/openapi3/components/schemas/PartyIdentifier.yaml

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

package/fspiop/v2_0/openapi3/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/fspiop/v2_0/openapi3/components/schemas/PartyPersonalInfo.yaml

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

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

@@ -0,0 +1,10 @@
+title: PartyResult
+type: object
+description: Data model for the complex type PartyResult.
+properties:
+  partyId:
+    $ref: ./PartyIdInfo.yaml
+  errorInformation:
+    $ref: ./ErrorInformation.yaml
+required:
+  - partyId

package/fspiop/v2_0/openapi3/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/fspiop/v2_0/openapi3/components/schemas/PersonalIdentifierType.yaml

@@ -0,0 +1,51 @@
+title: PersonalIdentifierType
+type: string
+enum:
+  - PASSPORT
+  - NATIONAL_REGISTRATION
+  - DRIVING_LICENSE
+  - ALIEN_REGISTRATION
+  - NATIONAL_ID_CARD
+  - EMPLOYER_ID
+  - TAX_ID_NUMBER
+  - SENIOR_CITIZENS_CARD
+  - MARRIAGE_CERTIFICATE
+  - HEALTH_CARD
+  - VOTERS_ID
+  - UNITED_NATIONS
+  - OTHER_ID
+description: >-
+  Below are the allowed values for the enumeration.
+
+  - PASSPORT - A passport number is used as reference to a Party.
+
+  - NATIONAL_REGISTRATION - A national registration number is used as reference
+  to a Party.
+
+  - DRIVING_LICENSE - A driving license is used as reference to a Party.
+
+  - ALIEN_REGISTRATION - An alien registration number is used as reference to a
+  Party.
+
+  - NATIONAL_ID_CARD - A national ID card number is used as reference to a
+  Party.
+
+  - EMPLOYER_ID - A tax identification number is used as reference to a Party.
+
+  - TAX_ID_NUMBER - A tax identification number is used as reference to a Party.
+
+  - SENIOR_CITIZENS_CARD - A senior citizens card number is used as reference to
+  a Party.
+
+  - MARRIAGE_CERTIFICATE - A marriage certificate number is used as reference to
+  a Party.
+
+  - HEALTH_CARD - A health card number is used as reference to a Party.
+
+  - VOTERS_ID - A voter’s identification number is used as reference to a Party.
+
+  - UNITED_NATIONS - An UN (United Nations) number is used as reference to a
+  Party.
+
+  - OTHER_ID - Any other type of identification type number is used as reference
+  to a Party.

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

@@ -0,0 +1,5 @@
+title: QRCODE
+type: string
+minLength: 1
+maxLength: 64
+description: QR code used as a One Time Password.

package/fspiop/v2_0/openapi3/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