@mojaloop/api-snippets 13.0.1 → 13.0.5

package/CHANGELOG.md

@@ -1,4 +1,32 @@
 # Changelog: [mojaloop/api-snippets](https://github.com/mojaloop/api-snippets)
+### [13.0.5](https://github.com/mojaloop/api-snippets/compare/v13.0.4...v13.0.5) (2022-02-18)
+
+
+### Bug Fixes
+
+* fix enumeration for authentication response ([#118](https://github.com/mojaloop/api-snippets/issues/118)) ([29e64f0](https://github.com/mojaloop/api-snippets/commit/29e64f07c3ac217e0676d5dd6e04bf4f13eab4c0))
+
+### [13.0.4](https://github.com/mojaloop/api-snippets/compare/v13.0.3...v13.0.4) (2021-11-03)
+
+
+### Bug Fixes
+
+* invalid value string examples as numbers ([#117](https://github.com/mojaloop/api-snippets/issues/117)) ([46fc9ff](https://github.com/mojaloop/api-snippets/commit/46fc9ff058be60da1bd3325924e668a8a8c3853e))
+
+### [13.0.3](https://github.com/mojaloop/api-snippets/compare/v13.0.2...v13.0.3) (2021-10-20)
+
+
+### Maintenance
+
+* **thirdparty:** minor inline docs improvements ([#116](https://github.com/mojaloop/api-snippets/issues/116)) ([9615e66](https://github.com/mojaloop/api-snippets/commit/9615e664160249e89a4db14046ecfc9bb73664ab))
+
+### [13.0.2](https://github.com/mojaloop/api-snippets/compare/v13.0.1...v13.0.2) (2021-10-19)
+
+
+### Bug Fixes
+
+* adding currencies xxx and xts which are part of iso 4217 ([#115](https://github.com/mojaloop/api-snippets/issues/115)) ([f09fd82](https://github.com/mojaloop/api-snippets/commit/f09fd82cecbc6b36a8eca9d1abdfb67b4c6f7f48))
+
 ### [13.0.1](https://github.com/mojaloop/api-snippets/compare/v13.0.0...v13.0.1) (2021-10-12)
 
 

package/docs/fspiop-rest-v1.0-openapi3-snippets.yaml

@@ -2452,6 +2452,8 @@ components:
         - XDR
         - XOF
         - XPF
+        - XTS
+        - XXX
         - YER
         - ZAR
         - ZMW
@@ -2739,7 +2741,7 @@ components:
             amount:
               type: string
               description: Amount of money.
-              example: 123.45
+              example: '123.45'
         fees:
           properties:
             currency:
@@ -2749,7 +2751,7 @@ components:
             amount:
               type: string
               description: Amount of money.
-              example: 1.45
+              example: '1.45'
         transactionType:
           $ref: '#/components/schemas/TransactionType'
           description: Type of transaction that the quote is requested for.
@@ -3001,7 +3003,7 @@ components:
         amount:
           type: string
           description: Amount of Money.
-          example: 123.45
+          example: '123.45'
       required:
         - currency
         - amount
@@ -3562,7 +3564,7 @@ components:
             amount:
               type: string
               description: Amount of money.
-              example: 124.45
+              example: '124.45'
         payeeReceiveAmount:
           properties:
             currency:
@@ -3572,7 +3574,7 @@ components:
             amount:
               type: string
               description: Amount of money.
-              example: 123.45
+              example: '123.45'
         payeeFspFee:
           properties:
             currency:
@@ -3582,7 +3584,7 @@ components:
             amount:
               type: string
               description: Amount of money.
-              example: 1.45
+              example: '1.45'
         payeeFspCommission:
           properties:
             currency:
@@ -3592,7 +3594,7 @@ components:
             amount:
               type: string
               description: Amount of money.
-              example: 0
+              example: '0'
         expiration:
           type: string
           description: >-
@@ -3826,7 +3828,7 @@ components:
                 amount:
                   type: string
                   description: Amount of money.
-                  example: 123.45
+                  example: '123.45'
             fees:
               properties:
                 currency:
@@ -3836,7 +3838,7 @@ components:
                 amount:
                   type: string
                   description: Amount of money.
-                  example: 1.45
+                  example: '1.45'
             transactionType:
               $ref: '#/components/schemas/TransactionType'
               description: Type of transaction that the quote is requested for.
@@ -3872,7 +3874,7 @@ components:
             amount:
               type: string
               description: Amount of money.
-              example: 124.45
+              example: '124.45'
         payeeReceiveAmount:
           properties:
             currency:
@@ -3882,7 +3884,7 @@ components:
             amount:
               type: string
               description: Amount of money.
-              example: 123.45
+              example: '123.45'
         payeeFspFee:
           properties:
             currency:
@@ -3892,7 +3894,7 @@ components:
             amount:
               type: string
               description: Amount of money.
-              example: 1.45
+              example: '1.45'
         payeeFspCommission:
           properties:
             currency:
@@ -3902,7 +3904,7 @@ components:
             amount:
               type: string
               description: Amount of money.
-              example: 1.45
+              example: '1.45'
         ilpPacket:
           type: string
           description: The ILP Packet that must be attached to the transfer by the Payer.

package/docs/fspiop-rest-v1.1-openapi3-snippets.yaml

@@ -2654,6 +2654,8 @@ components:
         - XDR
         - XOF
         - XPF
+        - XTS
+        - XXX
         - YER
         - ZAR
         - ZMW

package/docs/thirdparty-openapi3-snippets.yaml

@@ -258,6 +258,8 @@ paths:
                             - XDR
                             - XOF
                             - XPF
+                            - XTS
+                            - XXX
                             - YER
                             - ZAR
                             - ZMW
@@ -492,13 +494,6 @@ paths:
                             - CONSENT
                             - THIRD_PARTY_LINK
                           description: >
-                            This is a variant based on FSPIOP `PartyIdType`
-                            specification.
-
-                            Main difference being the CONSENT and
-                            THIRD_PARTY_LINK enums.
-
-
                             Below are the allowed values for the enumeration.
 
                             - MSISDN - An MSISDN (Mobile Station International
@@ -532,7 +527,7 @@ paths:
                             number, birth certificate
 
                             number, and national registration number. The
-                            identifier number is added in
+                            identifier number is added in 
 
                             the PartyIdentifier element. The personal identifier
                             type is added in the
@@ -596,9 +591,28 @@ paths:
 
                             by the PartyIdentifier.
 
-                            - CONSENT - TBD
+                            - CONSENT - A Consent represents an agreement
+                            between a PISP, a Customer and
+
+                            a DFSP which allows the PISP permission to perform
+                            actions on behalf of the 
+
+                            customer. A Consent has an authoritative source:
+                            either the DFSP who issued 
+
+                            the Consent, or an Auth Service which administers
+                            the Consent.
+
+                            - THIRD_PARTY_LINK - A Third Party Link represents
+                            an agreement between a PISP,
 
-                            - THIRD_PARTY_LINK - TBD
+                            a DFSP, and a specific Customer's account at the
+                            DFSP. The content of the link 
+
+                            is created by the DFSP at the time when it gives
+                            permission to the PISP for 
+
+                            specific access to a given account.
                           example: PERSONAL_ID
                         partyIdentifier:
                           title: PartyIdentifier
@@ -856,12 +870,6 @@ paths:
                       enum: &ref_88
                         - THIRD_PARTY_LINK
                       description: >
-                        This is a variant based on FSPIOP `PartyIdType`
-                        specification.
-
-                        This validation interface should be use by `POST
-                        /thirdpartyRequests/transactions`
-
                         - THIRD_PARTY_LINK - is the DFSP's internal reference
                         which allows DFSP to find out the corresponding consent
                       example: PERSONAL_ID
@@ -2198,7 +2206,7 @@ paths:
                   maxLength: 512
                   description: >
                     The API data type Uri is a JSON string in a canonical format
-                    that is restricted by a \ regular expression for
+                    that is restricted by a regular expression for
                     interoperability reasons.
               required: &ref_106
                 - consentRequestId
@@ -2206,22 +2214,6 @@ paths:
                 - scopes
                 - authChannels
                 - callbackUri
-            example:
-              id: '456'
-              initiatorId: pispA
-              authChannels:
-                - WEB
-                - OTP
-              scopes:
-                - accountId: dfspa.username.1234
-                  actions:
-                    - accounts.transfer
-                    - accounts.getBalance
-                - accountId: dfspa.username.5678
-                  actions:
-                    - accounts.transfer
-                    - accounts.getBalance
-              callbackUri: 'pisp-app://callback.com'
       responses:
         '202':
           description: Accepted
@@ -2500,7 +2492,7 @@ paths:
                       maxLength: 512
                       description: >
                         The API data type Uri is a JSON string in a canonical
-                        format that is restricted by a \ regular expression for
+                        format that is restricted by a regular expression for
                         interoperability reasons.
                     authUri:
                       title: Uri
@@ -2511,7 +2503,7 @@ paths:
                       maxLength: 512
                       description: >
                         The API data type Uri is a JSON string in a canonical
-                        format that is restricted by a \ regular expression for
+                        format that is restricted by a regular expression for
                         interoperability reasons.
                   required: &ref_109
                     - scopes
@@ -2559,7 +2551,7 @@ paths:
                       maxLength: 512
                       description: >
                         The API data type Uri is a JSON string in a canonical
-                        format that is restricted by a \ regular expression for
+                        format that is restricted by a regular expression for
                         interoperability reasons.
                   required: &ref_112
                     - scopes
@@ -2968,12 +2960,10 @@ paths:
                 - title: ConsentPostRequestAUTH
                   type: object
                   description: >
-                    The object sent in a `POST /consents` request to
-                    AUTH-SERVICE by DFSP to store registered consent with
-                    PublicKey
+                    The object sent in a `POST /consents` request to the
+                    Auth-Service
 
-                    and whatever needed to perform authorization validation
-                    later
+                    by a DFSP to store registered Consent and credential
                   properties: &ref_118
                     consentId:
                       allOf:
@@ -2996,11 +2986,7 @@ paths:
                         Common ID between the PISP and FSP for the Consent
                         object
 
-                        decided by the DFSP who creates the Consent
-
-                        This field is REQUIRED for POST /consent.
-
-                        creation of this Consent.
+                        determined by the DFSP who creates the Consent.
                     scopes:
                       minLength: 1
                       maxLength: 256
@@ -3041,7 +3027,7 @@ paths:
                                 - "FIDO" - A FIDO public/private keypair
                                 - "GENERIC" - A Generic public/private keypair
                             status:
-                              title: CredentialStatus
+                              title: CredentialStatusPending
                               type: string
                               enum: &ref_115
                                 - PENDING
@@ -3176,9 +3162,9 @@ paths:
                   additionalProperties: false
                 - title: ConsentPostRequestPISP
                   type: object
-                  description: >-
-                    The object sent in a `POST /consents` request to PISP by
-                    DFSP to ask for delivering the credential object.
+                  description: >
+                    The provisional Consent object sent by the DFSP in `POST
+                    /consents`.
                   properties: &ref_120
                     consentId:
                       allOf:
@@ -3468,7 +3454,7 @@ paths:
                       type: object
                       properties:
                         status:
-                          title: CredentialStatus
+                          title: CredentialStatusVerified
                           type: string
                           enum: &ref_128
                             - VERIFIED
@@ -6653,14 +6639,14 @@ paths:
           application/json:
             schema:
               oneOf:
-                - title: ThirdpartyRequestsAuthorizationsIDPutResponseGeneric
+                - title: ThirdpartyRequestsAuthorizationsIDPutResponseRejected
                   type: object
                   description: >-
                     The object sent in the PUT
                     /thirdpartyRequests/authorizations/{ID} callback.
                   properties: &ref_147
                     responseType:
-                      title: AuthorizationResponseType
+                      title: AuthorizationResponseTypeRejected
                       description: |
                         The customer rejected the terms of the transfer.
                       type: string
@@ -7440,7 +7426,7 @@ paths:
         information regarding a previously created or requested authorization.
         The *{ID}*
 
-        in the URI should contain the verification request ID 
+        in the URI should contain the verification request ID
       parameters:
         - name: Accept
           in: header
@@ -7490,18 +7476,17 @@ paths:
         - sampled
       operationId: PutThirdpartyRequestsVerificationsById
       summary: PutThirdpartyRequestsVerificationsById
-      description: >
+      description: >-
         The HTTP request `PUT /thirdpartyRequests/verifications/{ID}` is used by
-        the Auth-Service to inform
-
-        the DFSP of a successful result in validating the verification of a
-        Thirdparty Transaction Request.
-
+        the Auth-Service to inform the DFSP of a successful result in validating
+        the verification of a Thirdparty Transaction Request.
 
-        If the validation fails, The Auth-Service MUST use `PUT
-        /thirdpartyRequests/verifications/{ID}/error`
+        If the validation fails, the auth-service will send back `PUT
+        /thirdpartyRequests/verifications/{ID}` with `authenticationResponse:
+        'REJECTED'`.
 
-        instead.
+        In unplanned error cases the Auth-Service MUST use `PUT
+        /thirdpartyRequests/verifications/{ID}/error`.
       parameters:
         - name: Content-Length
           in: header
@@ -7525,13 +7510,21 @@ paths:
               description: >-
                 The object sent in the PUT
                 /thirdpartyRequests/verifications/{ID} request.
-              properties: &ref_157
+              properties: &ref_158
                 authenticationResponse:
+                  title: AuthenticationResponse
                   type: string
-                  enum:
+                  enum: &ref_157
                     - VERIFIED
-                  description: The verification passed
-              required: &ref_158
+                    - REJECTED
+                  description: >-
+                    Below are the allowed values for the enumeration
+                    AuthenticationResponse.
+
+                    - VERIFIED - The challenge was correctly signed.
+
+                    - REJECTED - The challenge was not correctly signed.
+              required: &ref_159
                 - authenticationResponse
             example:
               authenticationResponse: VERIFIED
@@ -7928,11 +7921,6 @@ components:
       type: string
       enum: *ref_83
       description: >
-        This is a variant based on FSPIOP `PartyIdType` specification.
-
-        Main difference being the CONSENT and THIRD_PARTY_LINK enums.
-
-
         Below are the allowed values for the enumeration.
 
         - MSISDN - An MSISDN (Mobile Station International Subscriber Directory
@@ -7963,7 +7951,7 @@ components:
         certificate
 
         number, and national registration number. The identifier number is added
-        in
+        in 
 
         the PartyIdentifier element. The personal identifier type is added in
         the
@@ -8020,9 +8008,27 @@ components:
 
         by the PartyIdentifier.
 
-        - CONSENT - TBD
+        - CONSENT - A Consent represents an agreement between a PISP, a Customer
+        and
+
+        a DFSP which allows the PISP permission to perform actions on behalf of
+        the 
+
+        customer. A Consent has an authoritative source: either the DFSP who
+        issued 
+
+        the Consent, or an Auth Service which administers the Consent.
+
+        - THIRD_PARTY_LINK - A Third Party Link represents an agreement between
+        a PISP,
+
+        a DFSP, and a specific Customer's account at the DFSP. The content of
+        the link 
 
-        - THIRD_PARTY_LINK - TBD
+        is created by the DFSP at the time when it gives permission to the PISP
+        for 
+
+        specific access to a given account.
       example: PERSONAL_ID
     PartyIdentifier:
       title: PartyIdentifier
@@ -8181,11 +8187,6 @@ components:
       type: string
       enum: *ref_88
       description: >
-        This is a variant based on FSPIOP `PartyIdType` specification.
-
-        This validation interface should be use by `POST
-        /thirdpartyRequests/transactions`
-
         - THIRD_PARTY_LINK - is the DFSP's internal reference which allows DFSP
         to find out the corresponding consent
       example: PERSONAL_ID
@@ -8423,7 +8424,7 @@ components:
       maxLength: 512
       description: >
         The API data type Uri is a JSON string in a canonical format that is
-        restricted by a \ regular expression for interoperability reasons.
+        restricted by a regular expression for interoperability reasons.
     ConsentRequestsPostRequest:
       title: ConsentRequestsPostRequest
       type: object
@@ -8496,7 +8497,7 @@ components:
         - "FIDO" - A FIDO public/private keypair
         - "GENERIC" - A Generic public/private keypair
     CredentialStatusPending:
-      title: CredentialStatus
+      title: CredentialStatusPending
       type: string
       enum: *ref_115
       description: |
@@ -8560,20 +8561,17 @@ components:
     ConsentsPostRequestAUTH:
       title: ConsentPostRequestAUTH
       type: object
-      description: >
-        The object sent in a `POST /consents` request to AUTH-SERVICE by DFSP to
-        store registered consent with PublicKey
-
-        and whatever needed to perform authorization validation later
+      description: |
+        The object sent in a `POST /consents` request to the Auth-Service
+        by a DFSP to store registered Consent and credential
       properties: *ref_118
       required: *ref_119
       additionalProperties: false
     ConsentsPostRequestPISP:
       title: ConsentPostRequestPISP
       type: object
-      description: >-
-        The object sent in a `POST /consents` request to PISP by DFSP to ask for
-        delivering the credential object.
+      description: |
+        The provisional Consent object sent by the DFSP in `POST /consents`.
       properties: *ref_120
       required: *ref_121
     ConsentStatusIssued:
@@ -8627,7 +8625,7 @@ components:
       required: *ref_127
       additionalProperties: false
     CredentialStatusVerified:
-      title: CredentialStatus
+      title: CredentialStatusVerified
       type: string
       enum: *ref_128
       description: |
@@ -8717,13 +8715,13 @@ components:
       required: *ref_145
       additionalProperties: false
     AuthorizationResponseTypeRejected:
-      title: AuthorizationResponseType
+      title: AuthorizationResponseTypeRejected
       description: |
         The customer rejected the terms of the transfer.
       type: string
       enum: *ref_146
     ThirdpartyRequestsAuthorizationsIDPutResponseRejected:
-      title: ThirdpartyRequestsAuthorizationsIDPutResponseGeneric
+      title: ThirdpartyRequestsAuthorizationsIDPutResponseRejected
       type: object
       description: >-
         The object sent in the PUT /thirdpartyRequests/authorizations/{ID}
@@ -8789,14 +8787,22 @@ components:
       description: The object sent in the POST /thirdpartyRequests/verifications request.
       properties: *ref_155
       required: *ref_156
+    AuthenticationResponse:
+      title: AuthenticationResponse
+      type: string
+      enum: *ref_157
+      description: |-
+        Below are the allowed values for the enumeration AuthenticationResponse.
+        - VERIFIED - The challenge was correctly signed.
+        - REJECTED - The challenge was not correctly signed.
     ThirdpartyRequestsVerificationsIDPutResponse:
       title: ThirdpartyRequestsVerificationsIDPutResponse
       type: object
       description: >-
         The object sent in the PUT /thirdpartyRequests/verifications/{ID}
         request.
-      properties: *ref_157
-      required: *ref_158
+      properties: *ref_158
+      required: *ref_159
   parameters:
     ID:
       name: ID

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

@@ -83,7 +83,7 @@ properties:
           amount:
             type: string
             description: Amount of money.
-            example: 123.45
+            example: '123.45'
       fees:
         properties:
           currency:
@@ -93,7 +93,7 @@ properties:
           amount:
             type: string
             description: Amount of money.
-            example: 1.45
+            example: '1.45'
       transactionType:
         $ref: ./TransactionType.yaml
         description: Type of transaction that the quote is requested for.

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

@@ -166,6 +166,8 @@ enum:
   - XDR
   - XOF
   - XPF
+  - XTS
+  - XXX
   - YER
   - ZAR
   - ZMW

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

@@ -26,7 +26,7 @@ properties:
       amount:
         type: string
         description: Amount of money.
-        example: 123.45
+        example: '123.45'
   fees:
     properties:
       currency:
@@ -36,7 +36,7 @@ properties:
       amount:
         type: string
         description: Amount of money.
-        example: 1.45
+        example: '1.45'
   transactionType:
     $ref: ./TransactionType.yaml
     description: Type of transaction that the quote is requested for.

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

@@ -18,7 +18,7 @@ properties:
       amount:
         type: string
         description: Amount of money.
-        example: 124.45
+        example: '124.45'
   payeeReceiveAmount:
     properties:
       currency:
@@ -28,7 +28,7 @@ properties:
       amount:
         type: string
         description: Amount of money.
-        example: 123.45
+        example: '123.45'
   payeeFspFee:
     properties:
       currency:
@@ -38,7 +38,7 @@ properties:
       amount:
         type: string
         description: Amount of money.
-        example: 1.45
+        example: '1.45'
   payeeFspCommission:
     properties:
       currency:
@@ -48,7 +48,7 @@ properties:
       amount:
         type: string
         description: Amount of money.
-        example: 1.45
+        example: '1.45'
   ilpPacket:
     type: string
     description: The ILP Packet that must be attached to the transfer by the Payer.

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

@@ -9,7 +9,7 @@ properties:
   amount:
     type: string
     description: Amount of Money.
-    example: 123.45
+    example: '123.45'
 required:
   - currency
   - amount