chore: add CONSENT and THIRD_PARTY_LINK to thirdparty variant PartyId…

…Type (#46)
mojaloop · Jan 19, 2021 · ea8f76a · ea8f76a
1 parent c6f69c3
commit ea8f76a
Show file tree

Hide file tree

Showing 17 changed files with 404 additions and 38 deletions.
diff --git a/docs/thirdparty-openapi3-snippets.yaml b/docs/thirdparty-openapi3-snippets.yaml
@@ -80,6 +80,17 @@ components:
         - 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
+    AuthenticationType:
+      title: AuthenticationType
+      type: string
+      enum:
+        - OTP
+        - QRCODE
+      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.
+      example: OTP
     AuthorizationChannelType:
       title: AuthorizationChannelType
       type: string
@@ -738,6 +749,40 @@ components:
         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'
+    ErrorCode:
+      title: ErrorCode
+      type: string
+      pattern: '^[1-9]\d{3}$'
+      description: |
+        The API data type ErrorCode is a JSON String of four characters,
+        consisting of digits only. Negative numbers are not allowed.
+        A leading zero is not allowed. Each error code in the API is a
+        four-digit number, for example, 1234, where the first number
+        (1 in the example) represents the high-level error category,
+        the second number (2 in the example) represents the low-level error category,
+        and the last two numbers (34 in the example) represent the specific error.
+      example: 5100
+    ErrorDescription:
+      title: ErrorDescription
+      type: string
+      minLength: 1
+      maxLength: 128
+      description: Error description string.
+      example: This is an error description.
+    ErrorInformation:
+      title: ErrorInformation
+      type: object
+      description: Data model for the complex type ErrorInformation.
+      properties:
+        errorCode:
+          $ref: '#/components/schemas/ErrorCode'
+        errorDescription:
+          $ref: '#/components/schemas/ErrorDescription'
+        extensionList:
+          $ref: '#/components/schemas/ExtensionList'
+      required:
+        - errorCode
+        - errorDescription
     DateOfBirth:
       title: DateofBirth (type Date)
       type: string
@@ -918,6 +963,27 @@ components:
       maxLength: 128
       description: Memo assigned to transaction.
       example: Note sent to Payee.
+    ParticipantsPostRequest:
+      title: ParticipantsPostRequest
+      type: object
+      description: The object sent in the POST /participants request.
+      properties:
+        requestId:
+          $ref: '#/components/schemas/CorrelationId'
+        partyList:
+          type: array
+          items:
+            $ref: '#/components/schemas/PartyIdInfo'
+          minItems: 1
+          maxItems: 10000
+          description: |
+            List of PartyIdInfo elements that the client would like to update
+            or create FSP information about.
+        currency:
+          $ref: '#/components/schemas/Currency'
+      required:
+        - requestId
+        - partyList
     PartiesTypeIDPutResponse:
       title: PartiesTypeIDPutResponse
       type: object
@@ -942,12 +1008,7 @@ components:
         merchantClassificationCode:
           $ref: '#/components/schemas/MerchantClassificationCode'
         name:
-          title: PartyName
-          type: string
-          minLength: 1
-          maxLength: 128
-          description: Name of the Party. Could be a real name or a nickname.
-          example: Henrik Karlsson
+          $ref: '#/components/schemas/PartyName'
         personalInfo:
           $ref: '#/components/schemas/PartyPersonalInfo'
       required:
@@ -963,6 +1024,13 @@ components:
           $ref: '#/components/schemas/MiddleName'
         lastName:
           $ref: '#/components/schemas/LastName'
+    PartyIdentifier:
+      title: PartyIdentifier
+      type: string
+      minLength: 1
+      maxLength: 128
+      description: Identifier of the Party.
+      example: 16135551212
     PartyIdInfo:
       title: PartyIdInfo
       type: object
@@ -971,23 +1039,13 @@ components:
         partyIdType:
           $ref: '#/components/schemas/PartyIdType'
         partyIdentifier:
-          title: PartyIdentifier
-          type: string
-          minLength: 1
-          maxLength: 128
-          description: Identifier of the Party.
-          example: 16135551212
+          $ref: '#/components/schemas/PartyIdentifier'
         partySubIdOrType:
-          title: PartySubIdOrType
-          type: string
-          minLength: 1
-          maxLength: 128
-          description: |
-            Either a sub-identifier of a PartyIdentifier, or a sub-type of the
-            PartyIdType, normally a PersonalIdentifierType.
-          example: DRIVING_LICENSE
+          $ref: '#/components/schemas/PartySubIdOrType'
         fspId:
           $ref: '#/components/schemas/FspId'
+        extensionList:
+          $ref: '#/components/schemas/ExtensionList'
       required:
         - partyIdType
         - partyIdentifier
@@ -1003,7 +1061,12 @@ components:
         - ACCOUNT_ID
         - IBAN
         - ALIAS
+        - 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 Subscriber Directory
         Number, that is, the phone number) is used as reference to a participant.
@@ -1039,7 +1102,16 @@ components:
         The ALIAS identifier can be in any format. It is also possible to use the
         PartySubIdOrType element for identifying an account under an Alias defined
         by the PartyIdentifier.
+        - CONSENT - TBD
+        - THIRD_PARTY_LINK - TBD
       example: PERSONAL_ID
+    PartyName:
+      title: PartyName
+      type: string
+      minLength: 1
+      maxLength: 128
+      description: Name of the Party. Could be a real name or a nickname.
+      example: Henrik Karlsson
     PartyPersonalInfo:
       title: PartyPersonalInfo
       type: object
@@ -1049,6 +1121,26 @@ components:
           $ref: '#/components/schemas/PartyComplexName'
         dateOfBirth:
           $ref: '#/components/schemas/DateOfBirth'
+    PartyResult:
+      title: PartyResult
+      type: object
+      description: Data model for the complex type PartyResult.
+      properties:
+        partyId:
+          $ref: '#/components/schemas/PartyIdInfo'
+        errorInformation:
+          $ref: '#/components/schemas/ErrorInformation'
+      required:
+        - partyId
+    PartySubIdOrType:
+      title: PartySubIdOrType
+      type: string
+      minLength: 1
+      maxLength: 128
+      description: |
+        Either a sub-identifier of a PartyIdentifier, or a sub-type of the
+        PartyIdType, normally a PersonalIdentifierType.
+      example: DRIVING_LICENSE
     QuotesIDPutResponse:
       title: QuotesIDPutResponse
       type: object
@@ -1274,6 +1366,37 @@ components:
         - amount
         - transactionType
         - expiration
+    TransactionRequestsPostRequest:
+      title: TransactionRequestsPostRequest
+      type: object
+      description: The object sent in the POST /transactionRequests request.
+      properties:
+        transactionRequestId:
+          $ref: '#/components/schemas/CorrelationId'
+        payee:
+          $ref: '#/components/schemas/Party'
+        payer:
+          $ref: '#/components/schemas/PartyIdInfo'
+        amount:
+          $ref: '#/components/schemas/Money'
+        transactionType:
+          $ref: '#/components/schemas/TransactionType'
+        note:
+          $ref: '#/components/schemas/Note'
+        geoCode:
+          $ref: '#/components/schemas/GeoCode'
+        authenticationType:
+          $ref: '#/components/schemas/AuthenticationType'
+        expiration:
+          $ref: '#/components/schemas/DateTime'
+        extensionList:
+          $ref: '#/components/schemas/ExtensionList'
+      required:
+        - transactionRequestId
+        - payee
+        - payer
+        - amount
+        - transactionType
     TransactionRequestState:
       title: TransactionRequestState
       type: string