@mojaloop/api-snippets 12.6.4 → 12.6.8

package/CHANGELOG.md

@@ -1,4 +1,18 @@
 # Changelog: [mojaloop/api-snippets](https://github.com/mojaloop/api-snippets)
+### [12.6.6](https://github.com/mojaloop/api-snippets/compare/v12.6.5...v12.6.6) (2021-08-26)
+
+
+### Bug Fixes
+
+* **thirdparty:** missing and invalid payloads ([#108](https://github.com/mojaloop/api-snippets/issues/108)) ([3dac4a9](https://github.com/mojaloop/api-snippets/commit/3dac4a93643c2fd31ba5db672707172e173066fe))
+
+### [12.6.5](https://github.com/mojaloop/api-snippets/compare/v12.6.4...v12.6.5) (2021-08-25)
+
+
+### Bug Fixes
+
+* **payload:** bad use of refs in TPR Authorizations ([#107](https://github.com/mojaloop/api-snippets/issues/107)) ([3414327](https://github.com/mojaloop/api-snippets/commit/34143271c8c3b72c518ec125ece63f2f2f558cce))
+
 ### [12.6.4](https://github.com/mojaloop/api-snippets/compare/v12.6.3...v12.6.4) (2021-08-24)
 
 

package/docs/thirdparty-openapi3-snippets.yaml

@@ -7248,23 +7248,35 @@ paths:
                   type: string
                   description: The challenge that the PISP's client is to sign
                 transferAmount:
-                  description: Data model for the complex type Money.
-                  title: Money
-                  type: object
-                  properties: *ref_0
-                  required: *ref_1
+                  allOf:
+                    - title: Money
+                      type: object
+                      description: Data model for the complex type Money.
+                      properties: *ref_0
+                      required: *ref_1
+                  description: >-
+                    The amount that will be debited from the sending customer’s 
+                    account as a consequence of the transaction.
                 payeeReceiveAmount:
-                  description: Data model for the complex type Money.
-                  title: Money
-                  type: object
-                  properties: *ref_0
-                  required: *ref_1
+                  allOf:
+                    - title: Money
+                      type: object
+                      description: Data model for the complex type Money.
+                      properties: *ref_0
+                      required: *ref_1
+                  description: >-
+                    The amount that will be credited to the receiving
+                    customer’s  account as a consequence of the transaction.
                 fees:
-                  description: Data model for the complex type Money.
-                  title: Money
-                  type: object
-                  properties: *ref_0
-                  required: *ref_1
+                  allOf:
+                    - title: Money
+                      type: object
+                      description: Data model for the complex type Money.
+                      properties: *ref_0
+                      required: *ref_1
+                  description: >-
+                    The amount of fees that the paying customer will be charged
+                    as part of the transaction.
                 payer:
                   allOf:
                     - title: PartyIdInfo
@@ -7292,27 +7304,33 @@ paths:
                   properties: *ref_65
                   required: *ref_66
                 expiration:
+                  allOf:
+                    - 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'
                   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).
-                  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)$
-                  example: '2016-05-24T08:38:08.699-04:00'
+                    The time by which the transfer must be completed, set by the
+                    payee DFSP.
                 extensionList:
+                  title: ExtensionList
+                  type: object
                   description: >-
                     Data model for the complex type ExtensionList. An optional
                     list of extensions, specific to deployment.
-                  title: ExtensionList
-                  type: object
                   properties: *ref_2
                   required: *ref_3
               required: &ref_153
@@ -7505,86 +7523,87 @@ paths:
 
             **Note:** The API supports a maximum size of 5242880 bytes (5
             Megabytes).
+      requestBody:
+        description: Signed authorization object
+        required: true
+        content:
+          application/json:
+            schema:
+              oneOf:
+                - title: ThirdpartyRequestsAuthorizationsIDPutResponseFIDO
+                  type: object
+                  description: >-
+                    The object sent in the PUT
+                    /thirdpartyRequests/authorizations/{ID} callback.
+                  properties: &ref_154
+                    signedPayloadType:
+                      title: SignedPayloadTypeFIDO
+                      type: string
+                      enum: &ref_74
+                        - FIDO
+                      description: >-
+                        Describes a challenge that has been signed with FIDO
+                        Attestation flows
+                    signedPayload:
+                      title: FIDOPublicKeyCredentialAssertion
+                      type: object
+                      description: >
+                        An object sent in a `PUT
+                        /thirdpartyRequests/authorization/{ID}` request.
+
+                        based mostly on: https://webauthn.guide/#authentication
+
+                        AuthenticatorAssertionResponse
+                      properties: *ref_72
+                      required: *ref_73
+                      additionalProperties: false
+                  required: &ref_155
+                    - signedPayloadType
+                    - signedPayload
+                - title: ThirdpartyRequestsAuthorizationsIDPutResponseGeneric
+                  type: object
+                  description: >-
+                    The object sent in the PUT
+                    /thirdpartyRequests/authorizations/{ID} callback.
+                  properties: &ref_156
+                    signedPayloadType:
+                      title: SignedPayloadTypeGeneric
+                      type: string
+                      enum: &ref_75
+                        - GENERIC
+                      description: >-
+                        Describes a challenge that has been signed with a
+                        private key
+                    signedPayload:
+                      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.
+                  required: &ref_157
+                    - signedPayloadType
+                    - authenticationValue
+            example:
+              signedPayloadType: FIDO
+              signedPayload:
+                id: >-
+                  45c-TkfkjQovQeAWmOy-RLBHEJ_e4jYzQYgD8VdbkePgM5d98BaAadadNYrknxgH0jQEON8zBydLgh1EqoC9DA
+                rawId: >-
+                  45c+TkfkjQovQeAWmOy+RLBHEJ/e4jYzQYgD8VdbkePgM5d98BaAadadNYrknxgH0jQEON8zBydLgh1EqoC9DA==
+                response:
+                  authenticatorData: SZYN5YgOjGh0NBcPZHZgW4/krrmihjLHmVzzuoMdl2MBAAAACA==
+                  clientDataJSON: >-
+                    eyJ0eXBlIjoid2ViYXV0aG4uZ2V0IiwiY2hhbGxlbmdlIjoiQUFBQUFBQUFBQUFBQUFBQUFBRUNBdyIsIm9yaWdpbiI6Imh0dHA6Ly9sb2NhbGhvc3Q6NDIxODEiLCJjcm9zc09yaWdpbiI6ZmFsc2UsIm90aGVyX2tleXNfY2FuX2JlX2FkZGVkX2hlcmUiOiJkbyBub3QgY29tcGFyZSBjbGllbnREYXRhSlNPTiBhZ2FpbnN0IGEgdGVtcGxhdGUuIFNlZSBodHRwczovL2dvby5nbC95YWJQZXgifQ==
+                  signature: >-
+                    MEUCIDcJRBu5aOLJVc/sPyECmYi23w8xF35n3RNhyUNVwQ2nAiEA+Lnd8dBn06OKkEgAq00BVbmH87ybQHfXlf1Y4RJqwQ8=
+                type: public-key
       responses:
         '200':
-          description: |
-            information about result of required (via POST) /authorization
-          content:
-            application/json:
-              schema:
-                oneOf:
-                  - title: ThirdpartyRequestsAuthorizationsIDPutResponseFIDO
-                    type: object
-                    description: >-
-                      The object sent in the PUT
-                      /thirdpartyRequests/authorizations/{ID} callback.
-                    properties: &ref_154
-                      signedPayloadType:
-                        title: SignedPayloadTypeFIDO
-                        type: string
-                        enum: &ref_74
-                          - FIDO
-                        description: >-
-                          Describes a challenge that has been signed with FIDO
-                          Attestation flows
-                      signedPayload:
-                        title: FIDOPublicKeyCredentialAssertion
-                        type: object
-                        description: >
-                          An object sent in a `PUT
-                          /thirdpartyRequests/authorization/{ID}` request.
-
-                          based mostly on:
-                          https://webauthn.guide/#authentication
-
-                          AuthenticatorAssertionResponse
-                        properties: *ref_72
-                        required: *ref_73
-                        additionalProperties: false
-                    required: &ref_155
-                      - signedPayloadType
-                      - authenticationValue
-                  - title: ThirdpartyRequestsAuthorizationsIDPutResponseGeneric
-                    type: object
-                    description: >-
-                      The object sent in the PUT
-                      /thirdpartyRequests/authorizations/{ID} callback.
-                    properties: &ref_156
-                      signedPayloadType:
-                        title: SignedPayloadTypeGeneric
-                        type: string
-                        enum: &ref_75
-                          - GENERIC
-                        description: >-
-                          Describes a challenge that has been signed with a
-                          private key
-                      signedPayload:
-                        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.
-                    required: &ref_157
-                      - signedPayloadType
-                      - authenticationValue
-              example:
-                signedPayloadType: FIDO
-                signedPayload:
-                  id: >-
-                    45c-TkfkjQovQeAWmOy-RLBHEJ_e4jYzQYgD8VdbkePgM5d98BaAadadNYrknxgH0jQEON8zBydLgh1EqoC9DA
-                  rawId: >-
-                    45c+TkfkjQovQeAWmOy+RLBHEJ/e4jYzQYgD8VdbkePgM5d98BaAadadNYrknxgH0jQEON8zBydLgh1EqoC9DA==
-                  response:
-                    authenticatorData: SZYN5YgOjGh0NBcPZHZgW4/krrmihjLHmVzzuoMdl2MBAAAACA==
-                    clientDataJSON: >-
-                      eyJ0eXBlIjoid2ViYXV0aG4uZ2V0IiwiY2hhbGxlbmdlIjoiQUFBQUFBQUFBQUFBQUFBQUFBRUNBdyIsIm9yaWdpbiI6Imh0dHA6Ly9sb2NhbGhvc3Q6NDIxODEiLCJjcm9zc09yaWdpbiI6ZmFsc2UsIm90aGVyX2tleXNfY2FuX2JlX2FkZGVkX2hlcmUiOiJkbyBub3QgY29tcGFyZSBjbGllbnREYXRhSlNPTiBhZ2FpbnN0IGEgdGVtcGxhdGUuIFNlZSBodHRwczovL2dvby5nbC95YWJQZXgifQ==
-                    signature: >-
-                      MEUCIDcJRBu5aOLJVc/sPyECmYi23w8xF35n3RNhyUNVwQ2nAiEA+Lnd8dBn06OKkEgAq00BVbmH87ybQHfXlf1Y4RJqwQ8=
-                  type: public-key
+          description: OK
         '400':
           description: Bad Request
           content: *ref_20
@@ -8211,18 +8230,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
@@ -8246,13 +8264,21 @@ paths:
               description: >-
                 The object sent in the PUT
                 /thirdpartyRequests/verifications/{ID} request.
-              properties: &ref_162
+              properties: &ref_163
                 authenticationResponse:
+                  title: AuthenticationResponse
                   type: string
-                  enum:
+                  enum: &ref_162
                     - VERIFIED
-                  description: The verification passed
-              required: &ref_163
+                    - 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_164
                 - authenticationResponse
             example:
               authenticationResponse: VERIFIED
@@ -9529,14 +9555,22 @@ components:
       description: The object sent in the POST /thirdpartyRequests/verifications request.
       properties: *ref_160
       required: *ref_161
+    AuthenticationResponse:
+      title: AuthenticationResponse
+      type: string
+      enum: *ref_162
+      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_162
-      required: *ref_163
+      properties: *ref_163
+      required: *ref_164
   parameters:
     ID:
       name: ID

package/lib/thirdparty/index.d.ts

@@ -6,6 +6,7 @@ export declare namespace Schemas {
     type AccountsIDPutResponse = components['schemas']['AccountsIDPutResponse'];
     type Amount = components['schemas']['Amount'];
     type AmountType = components['schemas']['AmountType'];
+    type AuthenticationResponse = components['schemas']['AuthenticationResponse'];
     type AuthenticationType = components['schemas']['AuthenticationType'];
     type AuthorizationChannelType = components['schemas']['AuthorizationChannelType'];
     type AuthorizationResponseType = components['schemas']['AuthorizationResponseType'];
@@ -88,6 +89,10 @@ export declare namespace Schemas {
     type ThirdpartyRequestsTransactionsIDPatchResponse = components['schemas']['ThirdpartyRequestsTransactionsIDPatchResponse'];
     type ThirdpartyRequestsTransactionsIDPutResponse = components['schemas']['ThirdpartyRequestsTransactionsIDPutResponse'];
     type ThirdpartyRequestsTransactionsPostRequest = components['schemas']['ThirdpartyRequestsTransactionsPostRequest'];
+    type ThirdpartyRequestsAuthorizationsPostRequest = components['schemas']['ThirdpartyRequestsAuthorizationsPostRequest'];
+    type ThirdpartyRequestsAuthorizationsIDPutResponseFIDO = components['schemas']['ThirdpartyRequestsAuthorizationsIDPutResponseFIDO'];
+    type ThirdpartyRequestsAuthorizationsIDPutResponseGeneric = components['schemas']['ThirdpartyRequestsAuthorizationsIDPutResponseGeneric'];
+    type ThirdpartyRequestsAuthorizationsIDPutResponse = ThirdpartyRequestsAuthorizationsIDPutResponseFIDO | ThirdpartyRequestsAuthorizationsIDPutResponseGeneric;
     type ThirdpartyRequestsVerificationsIDPutResponse = components['schemas']['ThirdpartyRequestsVerificationsIDPutResponse'];
     type ThirdpartyRequestsVerificationsPostRequestFIDO = components['schemas']['ThirdpartyRequestsVerificationsPostRequestFIDO'];
     type ThirdpartyRequestsVerificationsPostRequestGeneric = components['schemas']['ThirdpartyRequestsVerificationsPostRequestGeneric'];

package/lib/thirdparty/openapi.d.ts

@@ -16093,7 +16093,7 @@ export interface operations {
                  */
                 challenge: string;
                 /**
-                 * Data model for the complex type Money.
+                 * The amount that will be debited from the sending customer’s  account as a consequence of the transaction.
                  */
                 transferAmount: {
                     /**
@@ -16106,7 +16106,7 @@ export interface operations {
                     amount: string;
                 };
                 /**
-                 * Data model for the complex type Money.
+                 * The amount that will be credited to the receiving customer’s  account as a consequence of the transaction.
                  */
                 payeeReceiveAmount: {
                     /**
@@ -16119,7 +16119,7 @@ export interface operations {
                     amount: string;
                 };
                 /**
-                 * Data model for the complex type Money.
+                 * The amount of fees that the paying customer will be charged as part of the transaction.
                  */
                 fees: {
                     /**
@@ -16376,7 +16376,7 @@ export interface operations {
                     balanceOfPayments?: string;
                 };
                 /**
-                 * 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).
+                 * The time by which the transfer must be completed, set by the payee DFSP.
                  */
                 expiration: string;
                 /**
@@ -16726,69 +16726,70 @@ export interface operations {
                 "Content-Length"?: number;
             };
         };
-        responses: {
-            /**
-             * information about result of required (via POST) /authorization
-             */
-            "200": {
-                "application/json": {
+        requestBody: {
+            "application/json": {
+                /**
+                 * Describes a challenge that has been signed with FIDO Attestation flows
+                 */
+                signedPayloadType: "FIDO";
+                /**
+                 * An object sent in a `PUT /thirdpartyRequests/authorization/{ID}` request.
+                 * based mostly on: https://webauthn.guide/#authentication
+                 * AuthenticatorAssertionResponse
+                 */
+                signedPayload: {
+                    /**
+                     * credential id: identifier of pair of keys, base64 encoded
+                     * https://w3c.github.io/webauthn/#ref-for-dom-credential-id
+                     */
+                    id: string;
                     /**
-                     * Describes a challenge that has been signed with FIDO Attestation flows
+                     * raw credential id: identifier of pair of keys, base64 encoded.
                      */
-                    signedPayloadType: "FIDO";
+                    rawId: string;
                     /**
-                     * An object sent in a `PUT /thirdpartyRequests/authorization/{ID}` request.
-                     * based mostly on: https://webauthn.guide/#authentication
                      * AuthenticatorAssertionResponse
                      */
-                    signedPayload?: {
+                    response: {
                         /**
-                         * credential id: identifier of pair of keys, base64 encoded
-                         * https://w3c.github.io/webauthn/#ref-for-dom-credential-id
+                         * Authenticator data object.
                          */
-                        id: string;
+                        authenticatorData: string;
                         /**
-                         * raw credential id: identifier of pair of keys, base64 encoded.
+                         * JSON string with client data.
                          */
-                        rawId: string;
+                        clientDataJSON: string;
                         /**
-                         * AuthenticatorAssertionResponse
+                         * The signature generated by the private key associated with this credential.
                          */
-                        response: {
-                            /**
-                             * Authenticator data object.
-                             */
-                            authenticatorData: string;
-                            /**
-                             * JSON string with client data.
-                             */
-                            clientDataJSON: string;
-                            /**
-                             * The signature generated by the private key associated with this credential.
-                             */
-                            signature: string;
-                            /**
-                             * This field is optionally provided by the authenticator, and
-                             * represents the user.id that was supplied during registration.
-                             */
-                            userHandle?: string;
-                        };
+                        signature: string;
                         /**
-                         * response type, we need only the type of public-key
+                         * This field is optionally provided by the authenticator, and
+                         * represents the user.id that was supplied during registration.
                          */
-                        type: "public-key";
+                        userHandle?: string;
                     };
-                } | {
-                    /**
-                     * Describes a challenge that has been signed with a private key
-                     */
-                    signedPayloadType: "GENERIC";
                     /**
-                     * 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.
+                     * response type, we need only the type of public-key
                      */
-                    signedPayload?: string;
+                    type: "public-key";
                 };
+            } | {
+                /**
+                 * Describes a challenge that has been signed with a private key
+                 */
+                signedPayloadType: "GENERIC";
+                /**
+                 * 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.
+                 */
+                signedPayload?: string;
             };
+        };
+        responses: {
+            /**
+             * OK
+             */
+            "200": unknown;
             /**
              * Bad Request
              */
@@ -17871,11 +17872,9 @@ export interface operations {
         };
     };
     /**
-     * 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.
-     *
-     * If the validation fails, The Auth-Service MUST use `PUT /thirdpartyRequests/verifications/{ID}/error`
-     * instead.
+     * 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.
+     * If the validation fails, the auth-service will send back `PUT /thirdpartyRequests/verifications/{ID}` with `authenticationResponse: 'REJECTED'`.
+     * In unplanned error cases the Auth-Service MUST use `PUT /thirdpartyRequests/verifications/{ID}/error`.
      */
     PutThirdpartyRequestsVerificationsById: {
         parameters: {
@@ -17891,9 +17890,11 @@ export interface operations {
         requestBody: {
             "application/json": {
                 /**
-                 * The verification passed
+                 * Below are the allowed values for the enumeration AuthenticationResponse.
+                 * - VERIFIED - The challenge was correctly signed.
+                 * - REJECTED - The challenge was not correctly signed.
                  */
-                authenticationResponse: "VERIFIED";
+                authenticationResponse: "VERIFIED" | "REJECTED";
             };
         };
         responses: {
@@ -21671,7 +21672,7 @@ export interface components {
              */
             challenge: string;
             /**
-             * Data model for the complex type Money.
+             * The amount that will be debited from the sending customer’s  account as a consequence of the transaction.
              */
             transferAmount: {
                 /**
@@ -21684,7 +21685,7 @@ export interface components {
                 amount: string;
             };
             /**
-             * Data model for the complex type Money.
+             * The amount that will be credited to the receiving customer’s  account as a consequence of the transaction.
              */
             payeeReceiveAmount: {
                 /**
@@ -21697,7 +21698,7 @@ export interface components {
                 amount: string;
             };
             /**
-             * Data model for the complex type Money.
+             * The amount of fees that the paying customer will be charged as part of the transaction.
              */
             fees: {
                 /**
@@ -21954,7 +21955,7 @@ export interface components {
                 balanceOfPayments?: string;
             };
             /**
-             * 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).
+             * The time by which the transfer must be completed, set by the payee DFSP.
              */
             expiration: string;
             /**
@@ -21993,7 +21994,7 @@ export interface components {
              * based mostly on: https://webauthn.guide/#authentication
              * AuthenticatorAssertionResponse
              */
-            signedPayload?: {
+            signedPayload: {
                 /**
                  * credential id: identifier of pair of keys, base64 encoded
                  * https://w3c.github.io/webauthn/#ref-for-dom-credential-id
@@ -22132,14 +22133,22 @@ export interface components {
              */
             signedPayload: string;
         };
+        /**
+         * Below are the allowed values for the enumeration AuthenticationResponse.
+         * - VERIFIED - The challenge was correctly signed.
+         * - REJECTED - The challenge was not correctly signed.
+         */
+        AuthenticationResponse: "VERIFIED" | "REJECTED";
         /**
          * The object sent in the PUT /thirdpartyRequests/verifications/{ID} request.
          */
         ThirdpartyRequestsVerificationsIDPutResponse: {
             /**
-             * The verification passed
+             * Below are the allowed values for the enumeration AuthenticationResponse.
+             * - VERIFIED - The challenge was correctly signed.
+             * - REJECTED - The challenge was not correctly signed.
              */
-            authenticationResponse: "VERIFIED";
+            authenticationResponse: "VERIFIED" | "REJECTED";
         };
     };
     responses: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mojaloop/api-snippets",
-  "version": "12.6.4",
+  "version": "12.6.8",
   "description": "Mojaloop API specification reusable snippets",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",

package/tests/dto/thirdparty.test.ts

@@ -110,7 +110,7 @@ describe('thirdparty', () => {
         origin: 'pisp.mojaloop.io',
         type: 'webauthn.create'
       }),
-      attestationObject: "some-attestation"
+      attestationObject: 'some-attestation'
     },
     type: 'public-key'
   }
@@ -447,7 +447,7 @@ describe('thirdparty', () => {
           origin: 'pisp.mojaloop.io',
           type: 'webauthn.create'
         }),
-        attestationObject: "some-attestation"
+        attestationObject: 'some-attestation'
       },
       type: 'public-key'
     }
@@ -464,9 +464,9 @@ describe('thirdparty', () => {
           origin: 'pisp.mojaloop.io',
           type: 'webauthn.create'
         }),
-        authenticatorData: "some-data",
-        signature: "some-signature",
-        userHandle: "some-user-handle"
+        authenticatorData: 'some-data',
+        signature: 'some-signature',
+        userHandle: 'some-user-handle'
       },
       type: 'public-key'
     }
@@ -551,6 +551,70 @@ describe('thirdparty', () => {
     expect(thirdpartyRequestsTransactionsPostRequest).toBeDefined()
   })
 
+  test('ThirdpartyRequestsAuthorizationsPostRequest', () => {
+    const thirdpartyRequestsAuthorizationPostRequest: Schemas.ThirdpartyRequestsAuthorizationsPostRequest = {
+      authorizationRequestId: '5f8ee7f9-290f-4e03-ae1c-1e81ecf398df',
+      transactionRequestId: '2cf08eed-3540-489e-85fa-b2477838a8c5',
+      challenge: '<base64 encoded binary - the encoded challenge>',
+      transferAmount: {
+        amount: '100',
+        currency: 'USD'
+      },
+      payeeReceiveAmount: {
+        amount: '99',
+        currency: 'USD'
+      },
+      fees: {
+        amount: '1',
+        currency: 'USD'
+      },
+      payee: {
+        partyIdInfo: {
+          partyIdType: 'MSISDN',
+          partyIdentifier: '+4412345678',
+          fspId: 'dfspb'
+        }
+      },
+      payer: {
+        partyIdType: 'THIRD_PARTY_LINK',
+        partyIdentifier: 'qwerty-123456',
+        fspId: 'dfspa'
+      },
+      transactionType: {
+        scenario: 'TRANSFER',
+        initiator: 'PAYER',
+        initiatorType: 'CONSUMER'
+      },
+      expiration: '2020-06-15T12:00:00.000Z'
+    }
+    expect(thirdpartyRequestsAuthorizationPostRequest).toBeDefined()
+  })
+
+  test('ThirdpartyRequestsAuthorizationsIDPutResponseFIDO', () => {
+    const thirdpartyRequestsAuthorizationsIDPutResponseFIDO: Schemas.ThirdpartyRequestsAuthorizationsIDPutResponseFIDO = {
+      signedPayloadType: 'FIDO',
+      signedPayload: {
+        id: '45c-TkfkjQovQeAWmOy-RLBHEJ_e4jYzQYgD8VdbkePgM5d98BaAadadNYrknxgH0jQEON8zBydLgh1EqoC9DA',
+        rawId: '45c+TkfkjQovQeAWmOy+RLBHEJ/e4jYzQYgD8VdbkePgM5d98BaAadadNYrknxgH0jQEON8zBydLgh1EqoC9DA==',
+        response: {
+          authenticatorData: 'SZYN5YgOjGh0NBcPZHZgW4/krrmihjLHmVzzuoMdl2MBAAAACA==',
+          clientDataJSON: 'eyJ0eXBlIjoid2ViYXV0aG4uZ2V0IiwiY2hhbGxlbmdlIjoiQUFBQUFBQUFBQUFBQUFBQUFBRUNBdyIsIm9yaWdpbiI6Imh0dHA6Ly9sb2NhbGhvc3Q6NDIxODEiLCJjcm9zc09yaWdpbiI6ZmFsc2UsIm90aGVyX2tleXNfY2FuX2JlX2FkZGVkX2hlcmUiOiJkbyBub3QgY29tcGFyZSBjbGllbnREYXRhSlNPTiBhZ2FpbnN0IGEgdGVtcGxhdGUuIFNlZSBodHRwczovL2dvby5nbC95YWJQZXgifQ==',
+          signature: 'MEUCIDcJRBu5aOLJVc/sPyECmYi23w8xF35n3RNhyUNVwQ2nAiEA+Lnd8dBn06OKkEgAq00BVbmH87ybQHfXlf1Y4RJqwQ8='
+        },
+        type: 'public-key'
+      }
+    }
+    expect(thirdpartyRequestsAuthorizationsIDPutResponseFIDO).toBeDefined()
+  })
+
+  test('ThirdpartyRequestsAuthorizationsIDPutResponseGeneric', () => {
+    const thirdpartyRequestsAuthorizationsIDPutResponseGeneric: Schemas.ThirdpartyRequestsAuthorizationsIDPutResponseGeneric = {
+      signedPayloadType: 'GENERIC',
+      signedPayload: 'some string public key',
+    }
+    expect(thirdpartyRequestsAuthorizationsIDPutResponseGeneric).toBeDefined()
+  })
+
   test('TransactionRequestState', () => {
     const transactionRequestState: Schemas.TransactionRequestState = 'PENDING'
     expect(transactionRequestState).toBeDefined()

package/thirdparty/openapi3/components/schemas/AuthenticationResponse.yaml

@@ -0,0 +1,9 @@
+title: AuthenticationResponse
+type: string
+enum:
+  - VERIFIED
+  - REJECTED
+description: |-
+  Below are the allowed values for the enumeration AuthenticationResponse.
+  - VERIFIED - The challenge was correctly signed.
+  - REJECTED - The challenge was not correctly signed.

package/thirdparty/openapi3/components/schemas/ThirdpartyRequestsAuthorizationsIDPutResponseFIDO.yaml

@@ -8,4 +8,4 @@ properties:
     $ref: ./FIDOPublicKeyCredentialAssertion.yaml
 required:
   - signedPayloadType
-  - authenticationValue
+  - signedPayload

package/thirdparty/openapi3/components/schemas/ThirdpartyRequestsAuthorizationsPostRequest.yaml

@@ -10,17 +10,20 @@ properties:
     type: string
     description: The challenge that the PISP's client is to sign
   transferAmount:
-    $ref: ./Money.yaml
+    allOf:
+      - $ref: ./Money.yaml
     description: >-
       The amount that will be debited from the sending customer’s 
       account as a consequence of the transaction.
   payeeReceiveAmount:
-    $ref: ./Money.yaml
+    allOf:
+      - $ref: ./Money.yaml
     description: >-
       The amount that will be credited to the receiving customer’s 
       account as a consequence of the transaction.
   fees:
-    $ref: ./Money.yaml
+    allOf:
+      - $ref: ./Money.yaml
     description: >-
       The amount of fees that the paying customer will be charged
       as part of the transaction.
@@ -35,11 +38,11 @@ properties:
   transactionType:
     $ref: '../../../../fspiop/v1_1/openapi3/components/schemas/TransactionType.yaml'
   expiration:
-    $ref: ./DateTime.yaml
+    allOf:
+      - $ref: ./DateTime.yaml
     description: The time by which the transfer must be completed, set by the payee DFSP.
   extensionList:
     $ref: ./ExtensionList.yaml
-    description: 'Optional extension, specific to deployment.'
 required:
   - authorizationRequestId
   - transactionRequestId

package/thirdparty/openapi3/components/schemas/ThirdpartyRequestsVerificationsIDPutResponse.yaml

@@ -3,10 +3,6 @@ type: object
 description: The object sent in the PUT /thirdpartyRequests/verifications/{ID} request.
 properties:
   authenticationResponse:
-    type: string
-    enum:
-      - VERIFIED
-    description: 'The verification passed'
+    $ref: ./AuthenticationResponse.yaml
 required:
   - authenticationResponse
-  

package/thirdparty/openapi3/paths/thirdpartyRequests_authorizations_ID.yaml

@@ -22,27 +22,29 @@ put:
     - authorizations
   parameters:
     - $ref: ../components/parameters/Content-Length.yaml
+  requestBody:
+    description: Signed authorization object
+    required: true
+    content:
+      application/json:
+        schema:
+          oneOf:
+            - $ref: '../components/schemas/ThirdpartyRequestsAuthorizationsIDPutResponseFIDO.yaml'
+            - $ref: '../components/schemas/ThirdpartyRequestsAuthorizationsIDPutResponseGeneric.yaml'
+        example:
+          signedPayloadType: FIDO
+          signedPayload:
+            id: 45c-TkfkjQovQeAWmOy-RLBHEJ_e4jYzQYgD8VdbkePgM5d98BaAadadNYrknxgH0jQEON8zBydLgh1EqoC9DA
+            rawId: 45c+TkfkjQovQeAWmOy+RLBHEJ/e4jYzQYgD8VdbkePgM5d98BaAadadNYrknxgH0jQEON8zBydLgh1EqoC9DA==
+            response:
+              authenticatorData: SZYN5YgOjGh0NBcPZHZgW4/krrmihjLHmVzzuoMdl2MBAAAACA==
+              clientDataJSON: eyJ0eXBlIjoid2ViYXV0aG4uZ2V0IiwiY2hhbGxlbmdlIjoiQUFBQUFBQUFBQUFBQUFBQUFBRUNBdyIsIm9yaWdpbiI6Imh0dHA6Ly9sb2NhbGhvc3Q6NDIxODEiLCJjcm9zc09yaWdpbiI6ZmFsc2UsIm90aGVyX2tleXNfY2FuX2JlX2FkZGVkX2hlcmUiOiJkbyBub3QgY29tcGFyZSBjbGllbnREYXRhSlNPTiBhZ2FpbnN0IGEgdGVtcGxhdGUuIFNlZSBodHRwczovL2dvby5nbC95YWJQZXgifQ==
+              signature: MEUCIDcJRBu5aOLJVc/sPyECmYi23w8xF35n3RNhyUNVwQ2nAiEA+Lnd8dBn06OKkEgAq00BVbmH87ybQHfXlf1Y4RJqwQ8=
+            type: 'public-key'
+
   responses:
     200:
-      description: |
-        information about result of required (via POST) /authorization
-      content:
-        application/json:
-          schema:
-            oneOf:
-              - $ref: '../components/schemas/ThirdpartyRequestsAuthorizationsIDPutResponseFIDO.yaml'
-              - $ref: '../components/schemas/ThirdpartyRequestsAuthorizationsIDPutResponseGeneric.yaml'
-          example:
-            signedPayloadType: FIDO
-            signedPayload:
-              id: 45c-TkfkjQovQeAWmOy-RLBHEJ_e4jYzQYgD8VdbkePgM5d98BaAadadNYrknxgH0jQEON8zBydLgh1EqoC9DA
-              rawId: 45c+TkfkjQovQeAWmOy+RLBHEJ/e4jYzQYgD8VdbkePgM5d98BaAadadNYrknxgH0jQEON8zBydLgh1EqoC9DA==
-              response:
-                authenticatorData: SZYN5YgOjGh0NBcPZHZgW4/krrmihjLHmVzzuoMdl2MBAAAACA==
-                clientDataJSON: eyJ0eXBlIjoid2ViYXV0aG4uZ2V0IiwiY2hhbGxlbmdlIjoiQUFBQUFBQUFBQUFBQUFBQUFBRUNBdyIsIm9yaWdpbiI6Imh0dHA6Ly9sb2NhbGhvc3Q6NDIxODEiLCJjcm9zc09yaWdpbiI6ZmFsc2UsIm90aGVyX2tleXNfY2FuX2JlX2FkZGVkX2hlcmUiOiJkbyBub3QgY29tcGFyZSBjbGllbnREYXRhSlNPTiBhZ2FpbnN0IGEgdGVtcGxhdGUuIFNlZSBodHRwczovL2dvby5nbC95YWJQZXgifQ==
-                signature: MEUCIDcJRBu5aOLJVc/sPyECmYi23w8xF35n3RNhyUNVwQ2nAiEA+Lnd8dBn06OKkEgAq00BVbmH87ybQHfXlf1Y4RJqwQ8=
-              type: 'public-key'
-
+      $ref: ../components/responses/200.yaml
     400:
       $ref: ../components/responses/400.yaml
     401:

package/thirdparty/openapi3/paths/thirdpartyRequests_verifications_ID.yaml

@@ -17,12 +17,14 @@ put:
     - 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.
 
-    If the validation fails, The Auth-Service MUST use `PUT /thirdpartyRequests/verifications/{ID}/error`
-    instead.
+    If the validation fails, the auth-service will send back `PUT /thirdpartyRequests/verifications/{ID}`
+    with `authenticationResponse: 'REJECTED'`.
+
+    In unplanned error cases the Auth-Service MUST use `PUT /thirdpartyRequests/verifications/{ID}/error`.
   parameters:
     - $ref: ../components/parameters/Content-Length.yaml
   requestBody: