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

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

@@ -4,6 +4,5 @@ description: 'The object sent in the PUT /parties/{Type}/{ID} callback.'
 properties:
   party:
     $ref: ./Party.yaml
-    description: Information regarding the requested Party.
 required:
   - party

package/fspiop/v2_0/openapi3/components/headers/Content-Length.yaml

@@ -0,0 +1,9 @@
+required: false
+schema:
+  type: integer
+description: >-
+  The `Content-Length` header field indicates the anticipated size of the
+  payload body. Only sent if there is a body.
+
+
+  **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes).

package/fspiop/v2_0/openapi3/components/headers/Content-Type.yaml

@@ -0,0 +1,6 @@
+schema:
+  type: string
+required: true
+description: >-
+  The `Content-Type` header indicates the specific version of the API used to
+  send the payload body.

package/fspiop/v2_0/openapi3/components/parameters/Accept.yaml

@@ -0,0 +1,8 @@
+name: Accept
+in: header
+required: true
+schema:
+  type: string
+description: >-
+  The `Accept` header field indicates the version of the API the client would
+  like the server to use.

package/fspiop/v2_0/openapi3/components/parameters/Content-Length.yaml

@@ -0,0 +1,11 @@
+name: Content-Length
+in: header
+required: false
+schema:
+  type: integer
+description: >-
+  The `Content-Length` header field indicates the anticipated size of the
+  payload body. Only sent if there is a body.
+
+
+  **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes).

package/fspiop/v2_0/openapi3/components/parameters/Content-Type.yaml

@@ -0,0 +1,8 @@
+name: Content-Type
+in: header
+schema:
+  type: string
+required: true
+description: >-
+  The `Content-Type` header indicates the specific version of the API used to
+  send the payload body.

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

@@ -0,0 +1,6 @@
+name: Date
+in: header
+schema:
+  type: string
+required: true
+description: The `Date` header field indicates the date when the request was sent.

package/fspiop/v2_0/openapi3/components/parameters/FSPIOP-Destination.yaml

@@ -0,0 +1,13 @@
+name: FSPIOP-Destination
+in: header
+schema:
+  type: string
+required: false
+description: >-
+  The `FSPIOP-Destination` header field is a non-HTTP standard field used by the
+  API for HTTP header based routing of requests and responses to the
+  destination. The field must be set by the original sender of the request if
+  the destination is known (valid for all services except GET /parties) so that
+  any entities between the client and the server do not need to parse the
+  payload for routing purposes. If the destination is not known (valid for
+  service GET /parties), the field should be left empty.

package/fspiop/v2_0/openapi3/components/parameters/FSPIOP-Encryption.yaml

@@ -0,0 +1,8 @@
+name: FSPIOP-Encryption
+in: header
+schema:
+  type: string
+required: false
+description: >-
+  The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the
+  API for applying end-to-end encryption of the request.

package/fspiop/v2_0/openapi3/components/parameters/FSPIOP-HTTP-Method.yaml

@@ -0,0 +1,11 @@
+name: FSPIOP-HTTP-Method
+in: header
+schema:
+  type: string
+required: false
+description: >-
+  The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the
+  API for signature verification, should contain the service HTTP method.
+  Required if signature verification is used, for more information, see [the API
+  Signature
+  document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set).

package/fspiop/v2_0/openapi3/components/parameters/FSPIOP-Signature.yaml

@@ -0,0 +1,8 @@
+name: FSPIOP-Signature
+in: header
+schema:
+  type: string
+required: false
+description: >-
+  The `FSPIOP-Signature` header field is a non-HTTP standard field used by the
+  API for applying an end-to-end request signature.

package/fspiop/v2_0/openapi3/components/parameters/FSPIOP-Source.yaml

@@ -0,0 +1,10 @@
+name: FSPIOP-Source
+in: header
+schema:
+  type: string
+required: true
+description: >-
+  The `FSPIOP-Source` header field is a non-HTTP standard field used by the API
+  for identifying the sender of the HTTP request. The field should be set by the
+  original sender of the request. Required for routing and signature
+  verification (see header field `FSPIOP-Signature`).

package/fspiop/v2_0/openapi3/components/parameters/FSPIOP-URI.yaml

@@ -0,0 +1,10 @@
+name: FSPIOP-URI
+in: header
+schema:
+  type: string
+required: false
+description: >-
+  The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for
+  signature verification, should contain the service URI. Required if signature
+  verification is used, for more information, see [the API Signature
+  document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set).

package/fspiop/v2_0/openapi3/components/parameters/ID.yaml

@@ -0,0 +1,6 @@
+name: ID
+in: path
+required: true
+schema:
+  type: string
+description: The identifier value.

package/fspiop/v2_0/openapi3/components/parameters/SourceCurrency.yaml

@@ -0,0 +1,6 @@
+name: SourceCurrency
+in: path
+required: true
+schema:
+  type: string
+description: ISO 4217 currency code for the source currency.

package/fspiop/v2_0/openapi3/components/parameters/SubId.yaml

@@ -0,0 +1,8 @@
+name: SubId
+in: path
+required: true
+schema:
+  type: string
+description: >-
+  A sub-identifier of the party identifier, or a sub-type of the party
+  identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`.

package/fspiop/v2_0/openapi3/components/parameters/TargetCurrency.yaml

@@ -0,0 +1,6 @@
+name: TargetCurrency
+in: path
+required: true
+schema:
+  type: string
+description: ISO 4217 currency code for the target currency.

package/fspiop/v2_0/openapi3/components/parameters/Type.yaml

@@ -0,0 +1,6 @@
+name: Type
+in: path
+required: true
+schema:
+  type: string
+description: 'The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`.'

package/fspiop/v2_0/openapi3/components/parameters/X-Forwarded-For.yaml

@@ -0,0 +1,15 @@
+name: X-Forwarded-For
+in: header
+schema:
+  type: string
+required: false
+description: >-
+  The `X-Forwarded-For` header field is an unofficially accepted standard used
+  for informational purposes of the originating client IP address, as a request
+  might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For`
+  values should be expected and supported by implementers of the API.
+
+
+  **Note:** An alternative to `X-Forwarded-For` is defined in [RFC
+  7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is
+  less-used and supported than `X-Forwarded-For`.

package/fspiop/v2_0/openapi3/components/responses/200.yaml

@@ -0,0 +1 @@
+description: OK

package/fspiop/v2_0/openapi3/components/responses/202.yaml

@@ -0,0 +1 @@
+description: Accepted

package/fspiop/v2_0/openapi3/components/responses/400.yaml

@@ -0,0 +1,10 @@
+description: Bad Request
+content:
+  application/json:
+    schema:
+      $ref: ../schemas/ErrorInformationResponse.yaml
+headers:
+  Content-Length:
+    $ref: ../headers/Content-Length.yaml
+  Content-Type:
+    $ref: ../headers/Content-Type.yaml

package/fspiop/v2_0/openapi3/components/responses/401.yaml

@@ -0,0 +1,10 @@
+description: Unauthorized
+content:
+  application/json:
+    schema:
+      $ref: ../schemas/ErrorInformationResponse.yaml
+headers:
+  Content-Length:
+    $ref: ../headers/Content-Length.yaml
+  Content-Type:
+    $ref: ../headers/Content-Type.yaml

package/fspiop/v2_0/openapi3/components/responses/403.yaml

@@ -0,0 +1,10 @@
+description: Forbidden
+content:
+  application/json:
+    schema:
+      $ref: ../schemas/ErrorInformationResponse.yaml
+headers:
+  Content-Length:
+    $ref: ../headers/Content-Length.yaml
+  Content-Type:
+    $ref: ../headers/Content-Type.yaml

package/fspiop/v2_0/openapi3/components/responses/404.yaml

@@ -0,0 +1,10 @@
+description: Not Found
+content:
+  application/json:
+    schema:
+      $ref: ../schemas/ErrorInformationResponse.yaml
+headers:
+  Content-Length:
+    $ref: ../headers/Content-Length.yaml
+  Content-Type:
+    $ref: ../headers/Content-Type.yaml

package/fspiop/v2_0/openapi3/components/responses/405.yaml

@@ -0,0 +1,10 @@
+description: Method Not Allowed
+content:
+  application/json:
+    schema:
+      $ref: ../schemas/ErrorInformationResponse.yaml
+headers:
+  Content-Length:
+    $ref: ../headers/Content-Length.yaml
+  Content-Type:
+    $ref: ../headers/Content-Type.yaml

package/fspiop/v2_0/openapi3/components/responses/406.yaml

@@ -0,0 +1,10 @@
+description: Not Acceptable
+content:
+  application/json:
+    schema:
+      $ref: ../schemas/ErrorInformationResponse.yaml
+headers:
+  Content-Length:
+    $ref: ../headers/Content-Length.yaml
+  Content-Type:
+    $ref: ../headers/Content-Type.yaml

package/fspiop/v2_0/openapi3/components/responses/501.yaml

@@ -0,0 +1,10 @@
+description: Not Implemented
+content:
+  application/json:
+    schema:
+      $ref: ../schemas/ErrorInformationResponse.yaml
+headers:
+  Content-Length:
+    $ref: ../headers/Content-Length.yaml
+  Content-Type:
+    $ref: ../headers/Content-Type.yaml

package/fspiop/v2_0/openapi3/components/responses/503.yaml

@@ -0,0 +1,10 @@
+description: Service Unavailable
+content:
+  application/json:
+    schema:
+      $ref: ../schemas/ErrorInformationResponse.yaml
+headers:
+  Content-Length:
+    $ref: ../headers/Content-Length.yaml
+  Content-Type:
+    $ref: ../headers/Content-Type.yaml

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

@@ -0,0 +1,11 @@
+title: Amount
+type: string
+pattern: '^([0]|([1-9][0-9]{0,17}))([.][0-9]{0,3}[1-9])?$'
+description: >-
+  The API data type Amount is a JSON String in a canonical format that is
+  restricted by a regular expression for interoperability reasons. This pattern
+  does not allow any trailing zeroes at all, but allows an amount without a
+  minor currency unit. It also only allows four digits in the minor currency
+  unit; a negative value is not allowed. Using more than 18 digits in the major
+  currency unit is not allowed.
+example: '123.45'

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

@@ -0,0 +1,14 @@
+title: AmountType
+type: string
+enum:
+  - SEND
+  - RECEIVE
+description: >-
+  Below are the allowed values for the enumeration AmountType.
+
+  - SEND - Amount the Payer would like to send, that is, the amount that should
+  be withdrawn from the Payer account including any fees.
+
+  - RECEIVE - Amount the Payer would like the Payee to receive, that is, the
+  amount that should be sent to the receiver exclusive of any fees.
+example: 'RECEIVE'

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

@@ -0,0 +1,11 @@
+title: AuthenticationInfo
+type: object
+description: Data model for the complex type AuthenticationInfo.
+properties:
+  authentication:
+    $ref: ./AuthenticationType.yaml
+  authenticationValue:
+    $ref: ./AuthenticationValue.yaml
+required:
+  - authentication
+  - authenticationValue

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

@@ -0,0 +1,12 @@
+title: AuthenticationType
+type: string
+enum:
+  - OTP
+  - QRCODE
+  - U2F
+description: |-
+  Below are the allowed values for the enumeration AuthenticationType.
+  - OTP - One-time password generated by the Payer FSP.
+  - QRCODE - QR code used as One Time Password.
+  - U2F - U2F is a new addition isolated to Thirdparty stream.
+example: 'OTP'

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

@@ -0,0 +1,9 @@
+title: AuthenticationValue
+anyOf:
+  - $ref: ./OtpValue.yaml
+  - $ref: ./QRCODE.yaml
+  - $ref: ./U2FPinValue.yaml
+pattern: '^\d{3,10}$|^\S{1,64}$'
+description: >-
+  Contains the authentication value. The format depends on the authentication
+  type used in the AuthenticationInfo complex type.

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

@@ -0,0 +1,12 @@
+title: AuthorizationResponse
+type: string
+enum:
+  - ENTERED
+  - REJECTED
+  - RESEND
+description: |-
+  Below are the allowed values for the enumeration.
+  - ENTERED - Consumer entered the authentication value.
+  - REJECTED - Consumer rejected the transaction.
+  - RESEND - Consumer requested to resend the authentication value.
+example: 'ENTERED'

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

@@ -0,0 +1,10 @@
+title: AuthorizationsIDPutResponse
+type: object
+description: 'The object sent in the PUT /authorizations/{ID} callback.'
+properties:
+  authenticationInfo:
+    $ref: ./AuthenticationInfo.yaml
+  responseType:
+    $ref: ./AuthorizationResponse.yaml
+required:
+  - responseType

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

@@ -0,0 +1,9 @@
+title: BalanceOfPayments
+type: string
+pattern: '^[1-9]\d{2}$'
+description: >-
+  (BopCode) The API data type
+  [BopCode](https://www.imf.org/external/np/sta/bopcode/) is a JSON String of 3
+  characters, consisting of digits only. Negative numbers are not allowed. A
+  leading zero is not allowed.
+example: '123'

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

@@ -0,0 +1,7 @@
+type: string
+pattern: '^[A-Za-z0-9-_]+[=]{0,2}$'
+description: >-
+  The API data type BinaryString is a JSON String. The string is a base64url 
+  encoding of a string of raw bytes, where padding (character ‘=’) is added at
+  the end of the data if needed to ensure that the string is a multiple of 4
+  characters. The length restriction indicates the allowed number of characters.

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

@@ -0,0 +1,7 @@
+type: string
+pattern: '^[A-Za-z0-9-_]{43}$'
+description: >-
+  The API data type BinaryString32 is a fixed size version of the API data type
+  BinaryString, where the raw underlying data is always of 32 bytes. The data
+  type BinaryString32 should not use a padding character as the size of the
+  underlying data is fixed.

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'