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

package/docs/thirdparty-openapi3-snippets.yaml

@@ -4,7 +4,7 @@ info:
   title: Thirdparty Snippets
   description: |
     Based on sequence diagrams
-    (https://github.com/mojaloop/pisp/tree/master/docs/out).
+    (https://github.com/mojaloop/pisp/tree/main/docs/out).
     This is a work in progress.
   license:
     name: TBD
@@ -2619,7 +2619,7 @@ components:
         which was originally used by the PISP to identify the transaction
         request.
 
-        https://github.com/mojaloop/documentation/blob/master/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31612-post-thirdpartyrequestsauthorizations
+        https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31612-post-thirdpartyrequestsauthorizations
       properties:
         completedTimestamp:
           $ref: '#/components/schemas/DateTime'
@@ -2710,7 +2710,7 @@ components:
         features enabled. - PISP - Enum used to query for PISPs. - AUTH_SERVICE
         - Participants which provide Authentication Services.
 
-        https://github.com/mojaloop/documentation/blob/master/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#3229-servicetype
+        https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#3229-servicetype
       enum:
         - THIRD_PARTY_DFSP
         - PISP
@@ -3021,7 +3021,7 @@ components:
         is at the discretion of the address space owner (the payer DFSP in this
         case).
 
-        https://github.com/mojaloop/documentation/blob/master/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#3212-accountaddress
+        https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#3212-accountaddress
       pattern: ^([0-9A-Za-z_~\-\.]+[0-9A-Za-z_~\-])$
       minLength: 1
       maxLength: 1023
@@ -3031,7 +3031,7 @@ components:
       description: >-
         Data model for the complex type Account.
 
-        https://github.com/mojaloop/documentation/blob/master/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#3211-account
+        https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#3211-account
       properties:
         accountNickname:
           $ref: '#/components/schemas/Name'
@@ -3050,7 +3050,7 @@ components:
         The AccountList data model is used to hold information about the
         accounts that a party controls.
 
-        https://github.com/mojaloop/documentation/blob/master/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#3213-accountlist
+        https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#3213-accountlist
       items:
         $ref: '#/components/schemas/Account'
       minItems: 1
@@ -3068,7 +3068,7 @@ components:
         result of a request for accounts information. The identifier ID given in
         the call are the values given in the original request.
 
-        https://github.com/mojaloop/documentation/blob/master/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31121--put-accountsid
+        https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31121--put-accountsid
       properties:
         accounts:
           $ref: '#/components/schemas/AccountList'
@@ -3116,7 +3116,7 @@ components:
         DFSP, an account on which access types can be requested or granted. It
         also defines the access types which are requested or granted.
 
-        https://github.com/mojaloop/documentation/blob/master/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#32121-scope
+        https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#32121-scope
       properties:
         address:
           $ref: '#/components/schemas/AccountAddress'
@@ -3163,7 +3163,7 @@ components:
         Callback: PUT /consentRequests/{ID} Error callback: PUT
         /consentRequests/{ID}/error Data model - see below url
 
-        https://github.com/mojaloop/documentation/blob/master/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31212-post-consentrequests
+        https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31212-post-consentrequests
       properties:
         consentRequestId:
           $ref: '#/components/schemas/CorrelationId'
@@ -3299,7 +3299,7 @@ components:
         PISP will receive a token which they can use to prove to the DFSP that
         the user trusts this PISP.
 
-        https://github.com/mojaloop/documentation/blob/master/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31222-patch-consentrequestsid
+        https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31222-patch-consentrequestsid
       properties:
         authToken:
           $ref: '#/components/schemas/BinaryString'
@@ -3319,7 +3319,7 @@ components:
         "GENERIC" - The credential is based on a simple public key validation.
         Its payload is a GenericCredential object.
 
-        https://github.com/mojaloop/documentation/blob/master/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#3226-credentialtype
+        https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#3226-credentialtype
     CredentialStatusPending:
       title: CredentialStatusPending
       type: string
@@ -3685,7 +3685,7 @@ components:
         Callback - PUT /services/{ServiceType} Error Callback - PUT
         /services/{ServiceType}/error Data Model - Empty body
 
-        https://github.com/mojaloop/documentation/blob/master/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31531-put-servicesservicetype
+        https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31531-put-servicesservicetype
       properties:
         providers:
           type: array
@@ -3714,7 +3714,7 @@ components:
         PUT /thirdpartyRequests/transactions/{ID}/error Data Model - See link
         below
 
-        https://github.com/mojaloop/documentation/blob/master/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31712-post-thirdpartyrequeststransactions
+        https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31712-post-thirdpartyrequeststransactions
       properties:
         transactionRequestId:
           allOf:
@@ -3778,7 +3778,7 @@ components:
         /thirdpartyRequests/transactions/{ID}), the DFSP will send this
         callback.
 
-        https://github.com/mojaloop/documentation/blob/master/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31721-put-thirdpartyrequeststransactionsid
+        https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31721-put-thirdpartyrequeststransactionsid
       properties:
         transactionId:
           $ref: '#/components/schemas/CorrelationId'
@@ -3804,7 +3804,7 @@ components:
         PUT /thirdpartyRequests/authorizations/{ID}/error Data Model - See below
         url
 
-        https://github.com/mojaloop/documentation/blob/master/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31612-post-thirdpartyrequestsauthorizations
+        https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31612-post-thirdpartyrequestsauthorizations
       type: object
       properties:
         authorizationRequestId:
@@ -3914,7 +3914,7 @@ components:
         For this API, we represent ArrayBuffers as base64 encoded utf-8 strings.
 
 
-        https://github.com/mojaloop/documentation/blob/master/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#32128-fidopublickeycredentialassertion
+        https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#32128-fidopublickeycredentialassertion
       properties:
         id:
           type: string
@@ -4125,7 +4125,7 @@ components:
         request the check, or the {ID} that was used in the GET
         /thirdpartyRequests/verifications/{ID}.
 
-        https://github.com/mojaloop/documentation/blob/master/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31821-put-thirdpartyrequestsverificationsid
+        https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31821-put-thirdpartyrequestsverificationsid
       properties:
         authenticationResponse:
           $ref: '#/components/schemas/AuthenticationResponse'
@@ -4229,7 +4229,7 @@ components:
         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/master/Specification%20Document%20Set).
+        document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set).
     FSPIOP-HTTP-Method:
       name: FSPIOP-HTTP-Method
       in: header
@@ -4241,7 +4241,7 @@ components:
         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/master/Specification%20Document%20Set).
+        document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set).
     Accept:
       name: Accept
       in: header

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

@@ -8,4 +8,4 @@ description: >-
   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/master/Specification%20Document%20Set).
+  document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set).

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

@@ -7,4 +7,4 @@ 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/master/Specification%20Document%20Set).
+  document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set).

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/v1_1/openapi3/components/parameters/FSPIOP-HTTP-Method.yaml

@@ -8,4 +8,4 @@ description: >-
   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/master/Specification%20Document%20Set).
+  document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set).

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

@@ -7,4 +7,4 @@ 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/master/Specification%20Document%20Set).
+  document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set).

package/fspiop/v1_1/openapi3/openapi.yaml

@@ -4,14 +4,14 @@ info:
   title: Open API for FSP Interoperability (FSPIOP)
   description: >-
     Based on [API Definition updated on 2020-05-19 Version
-    1.1](https://github.com/mojaloop/mojaloop-specification/blob/master/documents/v1.1-document-set/API%20Definition_v1.1.pdf).
+    1.1](https://github.com/mojaloop/mojaloop-specification/blob/main/documents/v1.1-document-set/API%20Definition_v1.1.pdf).
 
 
     **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/master/LICENSE.md'
+    url: 'https://github.com/mojaloop/mojaloop-specification/blob/main/LICENSE.md'
   contact:
     name: Sam Kummary
     url: 'https://github.com/mojaloop/mojaloop-specification/issues'

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.