@mojaloop/api-snippets 18.3.2 → 18.4.0

package/thirdparty/v2_0/openapi3/components/schemas/SignedPayloadType.yaml

@@ -0,0 +1,9 @@
+title: SignedPayloadType
+type: string
+enum:
+  - FIDO
+  - GENERIC
+description: |-
+  Allowed values for the enumeration SignedPayloadType
+  - FIDO - describes a challenge that has been signed with FIDO Attestation flows
+  - GENERIC - describes a challenge that has been signed with a private key

package/thirdparty/v2_0/openapi3/components/schemas/SignedPayloadTypeFIDO.yaml

@@ -0,0 +1,5 @@
+title: SignedPayloadTypeFIDO
+type: string
+enum:
+  - FIDO
+description: Describes a challenge that has been signed with FIDO Attestation flows

package/thirdparty/v2_0/openapi3/components/schemas/SignedPayloadTypeGeneric.yaml

@@ -0,0 +1,5 @@
+title: SignedPayloadTypeGeneric
+type: string
+enum:
+  - GENERIC
+description: Describes a challenge that has been signed with a private key

package/thirdparty/v2_0/openapi3/components/schemas/Transaction.yaml

@@ -0,0 +1,43 @@
+title: Transaction
+type: object
+description: >-
+  Data model for the complex type Transaction. The Transaction type is used to
+  carry end-to-end data between the Payer FSP and the Payee FSP in the ILP
+  Packet. Both the transactionId and the quoteId in the data model are decided
+  by the Payer FSP in the POST /quotes request.
+properties:
+  transactionId:
+    $ref: ./CorrelationId.yaml
+    description: >-
+      ID of the transaction, the ID is decided by the Payer FSP during the
+      creation of the quote.
+  quoteId:
+    $ref: ./CorrelationId.yaml
+    description: >-
+      ID of the quote, the ID is decided by the Payer FSP during the creation of
+      the quote.
+  payee:
+    $ref: ./Party.yaml
+    description: Information about the Payee in the proposed financial transaction.
+  payer:
+    $ref: ./Party.yaml
+    description: Information about the Payer in the proposed financial transaction.
+  amount:
+    $ref: ./Money.yaml
+    description: Transaction amount to be sent.
+  transactionType:
+    $ref: ./TransactionType.yaml
+    description: Type of the transaction.
+  note:
+    $ref: ./Note.yaml
+    description: 'Memo associated to the transaction, intended to the Payee.'
+  extensionList:
+    $ref: ./ExtensionList.yaml
+    description: 'Optional extension, specific to deployment.'
+required:
+  - transactionId
+  - quoteId
+  - payee
+  - payer
+  - amount
+  - transactionType

package/thirdparty/v2_0/openapi3/components/schemas/TransactionRequestState.yaml

@@ -0,0 +1 @@
+$ref: '../../../../../fspiop/v2_0/openapi3/components/schemas/TransactionRequestState.yaml'

package/thirdparty/v2_0/openapi3/components/schemas/TransactionState.yaml

@@ -0,0 +1 @@
+$ref: '../../../../../fspiop/v2_0/openapi3/components/schemas/TransactionState.yaml'

package/thirdparty/v2_0/openapi3/components/schemas/TransactionType.yaml

@@ -0,0 +1 @@
+$ref: '../../../../../fspiop/v2_0/openapi3/components/schemas/TransactionType.yaml'

package/thirdparty/v2_0/openapi3/components/schemas/TransfersPostRequestFIDO.yaml

@@ -0,0 +1,15 @@
+title: TransfersPostRequestFIDO
+type: object
+description: 'The object sent in the PUT /tppAuthorizations/{ID} callback.'
+properties:
+  responseType:
+    $ref: ./AuthorizationResponseTypeAccepted.yaml
+  signedPayload:
+    $ref: ./SignedPayloadFIDO.yaml
+  extensionList:
+    $ref: ./ExtensionList.yaml
+required:
+  - responseType
+  - signedPayload
+additionalProperties: false
+

package/thirdparty/v2_0/openapi3/components/schemas/TransfersPostRequestGeneric.yaml

@@ -0,0 +1,15 @@
+title: TransfersPostRequestGeneric
+type: object
+description: 'The object sent in the PUT /tppAuthorizations/{ID} callback.'
+properties:
+  responseType:
+    $ref: ./AuthorizationResponseTypeAccepted.yaml
+  signedPayload:
+    $ref: ./SignedPayloadGeneric.yaml
+  extensionList:
+    $ref: ./ExtensionList.yaml
+required:
+  - responseType
+  - signedPayload
+additionalProperties: false
+

package/thirdparty/v2_0/openapi3/components/schemas/Uri.yaml

@@ -0,0 +1,8 @@
+title: Uri
+type: string
+pattern: '^(([^:/?#]+):)?(//([^/?#]*))?([^?#]*)(\?([^#]*))?(#(.*))?'
+minLength: 1
+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.

package/thirdparty/v2_0/openapi3/components/schemas/VerifiedCredential.yaml

@@ -0,0 +1,23 @@
+title: VerifiedCredential
+type: object
+description: |
+  A credential used to allow a user to prove their identity and access
+  to an account with a DFSP.
+
+  VerifiedCredential is a special formatting of Credential to allow us to be
+  more explicit about the `status` field - it should only ever be VERIFIED when
+  updating a credential.
+properties:
+  credentialType:
+    $ref: ./CredentialType.yaml
+  status:
+    $ref: ./CredentialStatusVerified.yaml
+  genericPayload:
+    $ref: ./GenericCredential.yaml
+  fidoPayload:
+    $ref: ./FIDOPublicKeyCredentialAttestation.yaml
+required:
+  - credentialType
+  - status
+additionalProperties: false
+

package/thirdparty/v2_0/openapi3/components/schemas/tppAccountRequestPostRequest.yaml

@@ -0,0 +1,35 @@
+title: AccountRequestPostRequest
+type: object
+description: >-
+  Used by: PISP
+
+  The /tppAccountsRequest resource is used to request consent from a user for access to their accounts information. This resource must be called before the /tppAccounts resource can be queried which provides the account information. 
+
+  Callback and data model for POST /tppAccountRequest:
+
+  Callback: PUT /tppAccountRequests/{ID}
+  Error callback: PUT /tppAccountRequests/{ID}/error
+  Data model - see below url
+
+  https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v2.0.0/api/thirdparty/data-models.md#31212-post-accountrequest
+properties:
+  accountRequestId:
+    $ref: ./CorrelationId.yaml
+  partyItentifier:
+    $ref: '../../../../../fspiop/v2_0/openapi3/components/schemas/PartyIdentifier.yaml'
+  authChannels:
+    type: array
+    minLength: 1
+    maxLength: 256
+    items:
+      $ref: ./ConsentRequestChannelType.yaml
+  #   The callback uri that the user will be redirected to after completing the
+  #   out of band WEB authentication with the DFSP. Used to allow the DFSP to
+  #   whitelist the PISP's url ahead of time.
+  callbackUri:
+    $ref: ./Uri.yaml
+required:
+  - accountRequestId
+  - partyIdInfo
+  - authChannels
+  - callbackUri

package/thirdparty/v2_0/openapi3/components/schemas/tppAccountRequestPutResponse.yaml

@@ -0,0 +1,30 @@
+title: AccountRequestPutResponse
+type: object
+description: >-
+  Used by: PISP
+
+  This is the message that the DFSP sends to the PISP to inform the PISP that 
+  the accountRequest has been accepted, and to communicate to the PISP which 
+  `authChannel` it should use to authenticate their user with. I.e. it is a response to a
+  POST /tppAccountsRequest request, or a GET /tppAccountsRequest/{ID} request.
+
+  When a PISP requests a series of permissions from a DFSP on behalf of a DFSP's customer, 
+  not all the permissions requested may be granted by the DFSP. Conversely, 
+  the out-of-loop authorization process may result in additional privileges 
+  being granted by the account holder to the PISP. The `PUT /tppAccountsRequest/<ID>` 
+  resource returns the current state of the permissions relating to a particular authorization request. 
+    
+properties:
+  authChannel:
+    $ref: ./ConsentRequestChannelType.yaml
+  callbackUri:
+    $ref: ./Uri.yaml
+  authUri:
+    $ref: ./Uri.yaml
+  authToken:
+    $ref: ./BinaryString.yaml
+  #   The callback uri that the user will be redirected to after completing the
+  #   out of band WEB authentication with the DFSP. Used to allow the DFSP to
+  #   whitelist the PISP's url ahead of time.
+required:
+  - authChannels

package/thirdparty/v2_0/openapi3/components/schemas/tppAccountsIDPutResponse.yaml

@@ -0,0 +1,21 @@
+title: AccountsIDPutResponse
+type: object
+description: >-
+  Callback and data model information for GET /accounts/{ID}:
+
+  Callback - PUT /tppAccounts/{ID}
+  Error Callback - PUT /tppAccounts/{ID}/error
+  Data Model - Empty body
+
+  The PUT /accounts/{ID} response is used to inform the requester of the 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/main/website/versioned_docs/v2.0.0/api/thirdparty/data-models.md#31121--put-accountsid
+properties:
+  accounts:
+    $ref: ./AccountList.yaml
+  extensionList:
+    $ref: ./ExtensionList.yaml
+required:
+  - accounts

package/thirdparty/v2_0/openapi3/components/schemas/tppAuthorizationsIDPutResponseFIDO.yaml

@@ -0,0 +1,15 @@
+title: tppAuthorizationsIDPutResponseFIDO
+type: object
+description: 'The object sent in the PUT /tppAuthorizations/{ID} callback.'
+properties:
+  responseType:
+    $ref: ./AuthorizationResponseTypeAccepted.yaml
+  signedPayload:
+    $ref: ./SignedPayloadFIDO.yaml
+  extensionList:
+    $ref: ./ExtensionList.yaml
+required:
+  - responseType
+  - signedPayload
+additionalProperties: false
+

package/thirdparty/v2_0/openapi3/components/schemas/tppAuthorizationsIDPutResponseGeneric.yaml

@@ -0,0 +1,15 @@
+title: tppAuthorizationsIDPutResponseGeneric
+type: object
+description: 'The object sent in the PUT /tppAuthorizations/{ID} callback.'
+properties:
+  responseType:
+    $ref: ./AuthorizationResponseTypeAccepted.yaml
+  signedPayload:
+    $ref: ./SignedPayloadGeneric.yaml
+  extensionList:
+    $ref: ./ExtensionList.yaml
+required:
+  - responseType
+  - signedPayload
+additionalProperties: false
+

package/thirdparty/v2_0/openapi3/components/schemas/tppAuthorizationsIDPutResponseRejected.yaml

@@ -0,0 +1,10 @@
+title: tppAuthorizationsIDPutResponseRejected
+type: object
+description: 'The object sent in the PUT /tppAuthorizations/{ID} callback.'
+properties:
+  responseType:
+    $ref: ./AuthorizationResponseTypeRejected.yaml
+  extensionList:
+    $ref: ./ExtensionList.yaml
+required:
+  - responseType

package/thirdparty/v2_0/openapi3/components/schemas/tppAuthorizationsPostRequest.yaml

@@ -0,0 +1,67 @@
+title: tppAuthorizationsPostRequest
+description: >-
+  Used by: DFSP
+
+  The HTTP request POST /tppAuthorizations is used to request
+  the validation by a customer for the transfer described in the request.
+
+  Callback and data model information for POST /tppAuthorizations:
+
+  Callback - PUT /tppAuthorizations/{ID}
+  Error Callback - PUT /tppAuthorizations/{ID}/error
+
+type: object
+properties:
+  authorizationRequestId:
+    $ref: ./CorrelationId.yaml
+  transactionRequestId:
+    $ref: ./CorrelationId.yaml
+  challenge:
+    type: string
+    description: The challenge that the PISP's client is to sign
+  transferAmount:
+    allOf:
+      - $ref: ./Money.yaml
+    description: >-
+      The amount that will be debited from the sending customer's
+      account as a consequence of the transaction.
+  payeeReceiveAmount:
+    allOf:
+      - $ref: ./Money.yaml
+    description: >-
+      The amount that will be credited to the receiving customer's
+      account as a consequence of the transaction.
+  fees:
+    allOf:
+      - $ref: ./Money.yaml
+    description: >-
+      The amount of fees that the paying customer will be charged
+      as part of the transaction.
+  payer:
+    allOf:
+      - $ref: ./PartyIdInfo.yaml
+    description: Information about the Payer type, id, sub-type/id, FSP Id in the proposed financial transaction.
+  payee:
+    allOf:
+      - $ref: ./Party.yaml
+    description: Information about the Payee in the proposed financial transaction.
+  transactionType:
+    $ref: '../../../../../fspiop/v2_0/openapi3/components/schemas/TransactionType.yaml'
+  expiration:
+    allOf:
+      - $ref: ./DateTime.yaml
+    description: The time by which the transfer must be completed, set by the payee DFSP.
+  extensionList:
+    $ref: ./ExtensionList.yaml
+required:
+  - authorizationRequestId
+  - transactionRequestId
+  - challenge
+  - transferAmount
+  - payeeReceiveAmount
+  - fees
+  - payer
+  - payee
+  - transactionType
+  - expiration
+additionalProperties: false

package/thirdparty/v2_0/openapi3/components/schemas/tppTransactionRequestPostRequest.yaml

@@ -0,0 +1,60 @@
+title: tppTransactionRequestPostRequest
+type: object
+description: >-
+  Used by: PISP
+
+  The HTTP request POST /tppTransationRequest is used to request the creation of a transaction request on the server for the transfer described in the request.
+
+  Callback and data model information for POST /tppTransationRequest:
+
+  Callback - PUT /tppTransationRequest/{ID}
+  Error Callback - PUT /tppTransationRequest/{ID}/error
+properties:
+  transactionRequestId:
+    allOf:
+      - $ref: ./CorrelationId.yaml
+    description: >
+      Common ID between the PISP and the Payer DFSP for the transaction request object.
+      The ID should be reused for resends of the same transaction request.
+      A new ID should be generated for each new transaction request.
+  payee:
+    allOf:
+      - $ref: ./Party.yaml
+    description: Information about the Payee in the proposed financial transaction.
+  payer:
+    allOf:
+      - $ref: ./PartyIdInfo.yaml
+    description: Information about the Payer in the proposed financial transaction.
+  amountType:
+    allOf:
+      - $ref: ./AmountType.yaml
+    description: 'SEND for sendAmount, RECEIVE for receiveAmount.'
+  amount:
+    allOf:
+      - $ref: ./Money.yaml
+    description: Requested amount to be transferred from the Payer to Payee.
+  transactionType:
+    allOf:
+      - $ref: ./TransactionType.yaml
+    description: Type of transaction.
+  note:
+    type: string
+    minLength: 1
+    maxLength: 256
+    description: A memo that will be attached to the transaction.
+  expiration:
+    type: string
+    description: >
+      Date and time until when the transaction request is valid. It can be set
+      to get a quick failure in case the peer FSP takes too long to respond.
+    example: '2016-05-24T08:38:08.699-04:00'
+  extensionList:
+    $ref: ./ExtensionList.yaml
+required:
+  - transactionRequestId
+  - payee
+  - payer
+  - amountType
+  - amount
+  - transactionType
+  - expiration

package/thirdparty/v2_0/openapi3/components/schemas/tppTransactionRequestPutResponse.yaml

@@ -0,0 +1,67 @@
+title: tppAuthorizationsPostRequest
+description: >-
+  Used by: DFSP
+
+  The HTTP request PUT /tppTransactionRequests/<ID> resource will have the following content. The <ID> in the request should match the transactionRequestId which was given when the transaction request was created.
+
+  It is used to return the: 
+  1. status of the customer information for validation.
+  2. the status of that agreement of terms for the transfer
+  3. a challenge that the PISP's client is to sign if the terms are agreed to and the transaction is to be authorized.
+
+type: object
+properties:
+  transactionRequestId:
+    $ref: ./CorrelationId.yaml
+  challenge:
+    type: string
+    description: The challenge that the PISP's client is to sign
+  transactionId:
+    $ref: ./CorrelationId.yaml
+    description: The unique identifier for the proposed transaction. It is set by the payer DFSP and signed by the payee DFSP as part of the terms of the transfer
+  transferAmount:
+    allOf:
+      - $ref: ./Money.yaml
+    description: >-
+      The amount that will be debited from the sending customer's
+      account as a consequence of the transaction.
+  payeeReceiveAmount:
+    allOf:
+      - $ref: ./Money.yaml
+    description: >-
+      The amount that will be credited to the receiving customer's
+      account as a consequence of the transaction.
+  fees:
+    allOf:
+      - $ref: ./Money.yaml
+    description: >-
+      The amount of fees that the paying customer will be charged
+      as part of the transaction.
+  payer:
+    allOf:
+      - $ref: ./PartyIdInfo.yaml
+    description: Information about the Payer type, id, sub-type/id, FSP Id in the proposed financial transaction.
+  payee:
+    allOf:
+      - $ref: ./Party.yaml
+    description: Information about the Payee in the proposed financial transaction.
+  transactionType:
+    $ref: '../../../../../fspiop/v2_0/openapi3/components/schemas/TransactionType.yaml'
+  expiration:
+    allOf:
+      - $ref: ./DateTime.yaml
+    description: The time by which the transfer must be completed, set by the payee DFSP.
+  extensionList:
+    $ref: ./ExtensionList.yaml
+required:
+  - transactionRequestId
+  - transactionId
+  - challenge
+  - transferAmount
+  - payeeReceiveAmount
+  - fees
+  - payer
+  - payee
+  - transactionType
+  - expiration
+additionalProperties: false

package/thirdparty/v2_0/openapi3/components/schemas/tppTransfersPostRequest.yaml

@@ -0,0 +1,19 @@
+title: tppTransfersPostRequest
+type: object
+description: 'The object sent in the PUT /tppAuthorizations/{ID} callback.'
+properties:
+  executionRequestId:
+    $ref: ./CorrelationId.yaml
+  transactionRequestId:
+    $ref: ./CorrelationId.yaml
+  authenticationInfo:
+    oneOf:
+      - $ref: './TransfersPostRequestGeneric.yaml'
+      - $ref: './TransfersPostRequestFIDO.yaml'    
+  extensionList:
+    $ref: ./ExtensionList.yaml
+required:
+  - executionRequestId
+  - transactionRequestId
+  - authenticationInfo
+additionalProperties: false

package/thirdparty/v2_0/openapi3/components/schemas/tppTransfersPutResponse.yaml

@@ -0,0 +1,25 @@
+title: tppTransfersPutResponse
+type: object
+description: >-
+  Used by: DFSP
+
+  The issuing PISP will expect a response to their request for a transfer
+  which describes the finalized state of the requested transfer.
+
+  This response will be given by a PUT callback call on the
+  /tppTransfers/{ID} resource.
+
+  The {ID} given in the query string should be the executionRequestId which
+  was originally used by the PISP to initiate the transaction.
+
+  https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v2.0.0/api/thirdparty/data-models.md#31612-post-thirdpartyrequestsauthorizations
+properties:
+  completedTimestamp:
+    $ref: ./DateTime.yaml
+  transactionState:
+    $ref: ./TransactionState.yaml
+  extensionList:
+    $ref: ./ExtensionList.yaml
+required:
+  - transactionRequestState
+  - transactionState

package/thirdparty/v2_0/openapi3/components/schemas/tppVerificationsIDPutResponse.yaml

@@ -0,0 +1,19 @@
+title: tppVerificationsIDPutResponse
+type: object
+description: >-
+  Used by: Auth Service
+
+  The callback PUT /tppVerifications/{ID} is used to inform the
+  client of the result of an authorization check.
+  The {ID} in the URI should contain the authorizationRequestId
+  which was used to request the check, or the {ID} that was used in the
+  GET /tppVerifications/{ID}.
+
+  https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v2.0.0/api/thirdparty/data-models.md#31821-put-thirdpartyrequestsverificationsid
+properties:
+  authenticationResponse:
+    $ref: ./AuthenticationResponse.yaml
+  extensionList:
+    $ref: ./ExtensionList.yaml
+required:
+  - authenticationResponse

package/thirdparty/v2_0/openapi3/components/schemas/tppVerificationsPostRequestFIDO.yaml

@@ -0,0 +1,28 @@
+title: tppVerificationsPostRequestFIDO
+type: object
+description: The object sent in the POST /tppVerifications request.
+properties:
+  verificationRequestId:
+    allOf:
+      - $ref: ./CorrelationId.yaml
+  challenge:
+    type: string
+    description: Base64 encoded bytes - The challenge generated by the DFSP.
+  consentId:
+    allOf:
+      - $ref: ./CorrelationId.yaml
+    description: |
+      The id of the stored consent object that contains the credential with which to verify
+      the signed challenge against.
+  signedPayloadType:
+    $ref: ./SignedPayloadTypeFIDO.yaml
+  fidoSignedPayload:
+    $ref: ./FIDOPublicKeyCredentialAssertion.yaml
+  extensionList:
+    $ref: ./ExtensionList.yaml
+required:
+  - verificationRequestId
+  - challenge
+  - consentId
+  - signedPayloadType
+  - fidoSignedPayload

package/thirdparty/v2_0/openapi3/components/schemas/tppVerificationsPostRequestGeneric.yaml

@@ -0,0 +1,28 @@
+title: tppVerificationsPostRequestGeneric
+type: object
+description: The object sent in the POST /tppVerifications request.
+properties:
+  verificationRequestId:
+    allOf:
+      - $ref: ./CorrelationId.yaml
+  challenge:
+    type: string
+    description: Base64 encoded bytes - The challenge generated by the DFSP.
+  consentId:
+    allOf:
+      - $ref: ./CorrelationId.yaml
+    description: |
+      The id of the stored consent object that contains the credential with which to verify
+      the signed challenge against.
+  signedPayloadType:
+    $ref: ./SignedPayloadTypeGeneric.yaml
+  genericSignedPayload:
+    $ref: ./BinaryString.yaml
+  extensionList:
+    $ref: ./ExtensionList.yaml
+required:
+  - verificationRequestId
+  - challenge
+  - consentId
+  - signedPayloadType
+  - genericSignedPayload