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

package/sdk-scheme-adapter/v2_1_0/backend/paths/fxQuotes.yaml

@@ -0,0 +1,26 @@
+post:
+  description: >-
+    The HTTP request `POST /fxQuotes` is used to ask an FXP backend to provide a quotation for a currency conversion.
+  summary: Calculate FX quote
+  tags:
+    - Fx
+  operationId: FxQuotesPost
+  requestBody:
+    description: Details of the FX quote request.
+    required: true
+    content:
+      application/json:
+        schema:
+          $ref: ../../components/schemas/FxQuotesPostBackendRequest.yaml
+  responses:
+    '200':
+      description: Successful response.
+      content:
+        application/json:
+          schema:
+            $ref: ../../components/schemas/FxQuotesPostBackendResponse.yaml
+    '400':
+      $ref: ../../components/responses/400.yaml
+    '500':
+      $ref: ../../components/responses/500.yaml
+

package/sdk-scheme-adapter/v2_1_0/backend/paths/fxTransfers.yaml

@@ -0,0 +1,25 @@
+post:
+  description: >-
+    The HTTP request `POST /fxTransfers` is used to ask an FXP backend to confirm the execution of an agreed currency conversion.
+  summary: Perform FX transfer
+  tags:
+    - Fx
+  operationId: FxTransfersPost
+  requestBody:
+    description: Details of the FX transfer request.
+    required: true
+    content:
+      application/json:
+        schema:
+          $ref: ../../components/schemas/FxTransfersPostBackendRequest.yaml
+  responses:
+    '200':
+      description: Successful response.
+      content:
+        application/json:
+          schema:
+            $ref: ../../components/schemas/FxTransfersPostBackendResponse.yaml
+    '400':
+      $ref: ../../components/responses/400.yaml
+    '500':
+      $ref: ../../components/responses/500.yaml

package/sdk-scheme-adapter/v2_1_0/backend/paths/fxTransfersById.yaml

@@ -0,0 +1,21 @@
+put:
+  description: >-
+    The HTTP request `PUT /fxTransfers/{commitRequestId}` is used to notify an FXP backend about the status of currency conversion.
+  summary: FX Commit Notification
+  tags:
+    - Fx
+  operationId: FxTransfersById
+  requestBody:
+    description: Status of the FX transfer.
+    required: true
+    content:
+      application/json:
+        schema:
+          $ref: ../../components/schemas/FxTransfersPutBackendRequest.yaml
+  responses:
+    '200':
+      $ref: ../../components/responses/200.yaml
+    '400':
+      $ref: ../../components/responses/400.yaml
+    '500':
+      $ref: ../../components/responses/500.yaml

package/sdk-scheme-adapter/v2_1_0/components/parameters/ID.yaml

@@ -0,0 +1,6 @@
+name: ID
+in: path
+required: true
+schema:
+  type: string
+description: The identifier value.

package/sdk-scheme-adapter/v2_1_0/components/parameters/SubId.yaml

@@ -0,0 +1,8 @@
+name: SubId
+in: path
+required: true
+schema:
+  type: string
+description: >-
+  A sub-identifier of the party identifier, or a sub-type of the party
+  identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`.

package/sdk-scheme-adapter/v2_1_0/components/parameters/Type.yaml

@@ -0,0 +1,6 @@
+name: Type
+in: path
+required: true
+schema:
+  type: string
+description: The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`.

package/sdk-scheme-adapter/v2_1_0/components/parameters/bulkQuoteId.yaml

@@ -0,0 +1,8 @@
+name: bulkQuoteId
+in: path
+required: true
+schema:
+  $ref: ../schemas/CorrelationId.yaml
+description: >-
+  Identifier of the bulk transfer to continue as returned in the response to a
+  `POST /bulkTransfers` request.

package/sdk-scheme-adapter/v2_1_0/components/parameters/bulkTransactionId.yaml

@@ -0,0 +1,8 @@
+name: bulkTransactionId
+in: path
+required: true
+schema:
+  $ref: ../schemas/CorrelationId.yaml
+description: >-
+  Identifier of the bulk transaction to continue as returned in the response to a
+  `POST /bulkTransaction` request.

package/sdk-scheme-adapter/v2_1_0/components/parameters/bulkTransferId.yaml

@@ -0,0 +1,8 @@
+name: bulkTransferId
+in: path
+required: true
+schema:
+  $ref: ../schemas/CorrelationId.yaml
+description: >-
+  Identifier of the bulk transfer to continue as returned in the response to a
+  `POST /bulkTransfers` request.

package/sdk-scheme-adapter/v2_1_0/components/parameters/transactionRequestId.yaml

@@ -0,0 +1,8 @@
+name: transactionRequestId
+in: path
+required: true
+schema:
+  $ref: ../schemas/CorrelationId.yaml
+description: >-
+  Identifier of the merchant request to pay to continue as returned in
+  the response to a `POST /requestToPay` request.

package/sdk-scheme-adapter/v2_1_0/components/parameters/transferId.yaml

@@ -0,0 +1,8 @@
+name: transferId
+in: path
+required: true
+schema:
+  $ref: ../schemas/CorrelationId.yaml
+description: >-
+  Identifier of the transfer to continue as returned in the response to a `POST
+  /transfers` request.

package/sdk-scheme-adapter/v2_1_0/components/responses/200.yaml

@@ -0,0 +1 @@
+description: OK

package/sdk-scheme-adapter/v2_1_0/components/responses/400.yaml

@@ -0,0 +1,5 @@
+description: Malformed or missing required headers or parameters.
+content:
+  application/json:
+    schema:
+      $ref: ../schemas/errorResponse.yaml

package/sdk-scheme-adapter/v2_1_0/components/responses/404.yaml

@@ -0,0 +1,5 @@
+description: Not Found
+content:
+  application/json:
+    schema:
+      $ref: ../schemas/errorResponse.yaml

package/sdk-scheme-adapter/v2_1_0/components/responses/500.yaml

@@ -0,0 +1,5 @@
+description: An error occurred processing the request.
+content:
+  application/json:
+    schema:
+      $ref: ../schemas/errorResponse.yaml

package/sdk-scheme-adapter/v2_1_0/components/responses/accountsCreationCompleted.yaml

@@ -0,0 +1,5 @@
+description: Accounts creation completed
+content:
+  application/json:
+    schema:
+      $ref: ../schemas/accountsResponse.yaml

package/sdk-scheme-adapter/v2_1_0/components/responses/accountsCreationError.yaml

@@ -0,0 +1,5 @@
+description: An error occurred creating accounts
+content:
+  application/json:
+    schema:
+      $ref: ../schemas/errorAccountsResponse.yaml

package/sdk-scheme-adapter/v2_1_0/components/responses/accountsCreationTimeout.yaml

@@ -0,0 +1,5 @@
+description: Timeout occurred creating accounts
+content:
+  application/json:
+    schema:
+      $ref: ../schemas/errorAccountsResponse.yaml

package/sdk-scheme-adapter/v2_1_0/components/responses/bulkQuoteBadRequest.yaml

@@ -0,0 +1,5 @@
+description: Malformed or missing required body, headers or parameters
+content:
+  application/json:
+    schema:
+      $ref: ../schemas/bulkQuoteErrorResponse.yaml

package/sdk-scheme-adapter/v2_1_0/components/responses/bulkQuoteServerError.yaml

@@ -0,0 +1,5 @@
+description: An error occurred processing the bulk quote
+content:
+  application/json:
+    schema:
+      $ref: ../schemas/bulkQuoteErrorResponse.yaml

package/sdk-scheme-adapter/v2_1_0/components/responses/bulkQuoteSuccess.yaml

@@ -0,0 +1,5 @@
+description: Bulk quote completed successfully
+content:
+  application/json:
+    schema:
+      $ref: ../schemas/bulkQuoteResponse.yaml

package/sdk-scheme-adapter/v2_1_0/components/responses/bulkQuoteTimeout.yaml

@@ -0,0 +1,5 @@
+description: Timeout occurred processing the bulk quote
+content:
+  application/json:
+    schema:
+      $ref: ../schemas/bulkQuoteErrorResponse.yaml

package/sdk-scheme-adapter/v2_1_0/components/responses/bulkTransactionAccepted.yaml

@@ -0,0 +1 @@
+description: Bulk transfer accepted successfully

package/sdk-scheme-adapter/v2_1_0/components/responses/bulkTransactionBadRequest.yaml

@@ -0,0 +1,5 @@
+description: Malformed or missing required body, headers or parameters
+content:
+  application/json:
+    schema:
+      $ref: ../schemas/bulkTransferErrorResponse.yaml

package/sdk-scheme-adapter/v2_1_0/components/responses/bulkTransactionPutBadRequest.yaml

@@ -0,0 +1,7 @@
+description: Malformed or missing required body, headers or parameters
+content:
+  application/json:
+    schema:
+      oneOf:
+        - $ref: ../schemas/bulkTransactionAcceptPartyErrorResponse.yaml
+        - $ref: ../schemas/bulkTransactionAcceptQuoteErrorResponse.yaml

package/sdk-scheme-adapter/v2_1_0/components/responses/bulkTransferBadRequest.yaml

@@ -0,0 +1,5 @@
+description: Malformed or missing required body, headers or parameters
+content:
+  application/json:
+    schema:
+      $ref: ../schemas/bulkTransferErrorResponse.yaml

package/sdk-scheme-adapter/v2_1_0/components/responses/bulkTransferStatusResponse.yaml

@@ -0,0 +1,16 @@
+type: object
+required:
+- bulkTransferId
+- currentState
+- fulfils
+properties:
+  bulkTransferId:
+    $ref: ../schemas/CorrelationId.yaml
+  currentState:
+    $ref: ../schemas/bulkTransferStatus.yaml
+  fulfils:
+    type: array
+    minItems: 1
+    maxItems: 1000
+    items:
+      $ref: ../schemas/individualTransferFulfilment.yaml

package/sdk-scheme-adapter/v2_1_0/components/responses/bulkTransferSuccess.yaml

@@ -0,0 +1,5 @@
+description: Bulk transfer completed successfully
+content:
+  application/json:
+    schema:
+      $ref: ../schemas/bulkTransferResponse.yaml

package/sdk-scheme-adapter/v2_1_0/components/responses/errorResponse.yaml

@@ -0,0 +1,5 @@
+description: Internal Server Error
+content:
+  application/json:
+    schema:
+      $ref: ../schemas/errorResponse.yaml

package/sdk-scheme-adapter/v2_1_0/components/responses/partiesByIdError404.yaml

@@ -0,0 +1,8 @@
+description: PartiesByIdError404
+content:
+  application/json:
+    schema:
+      type: object
+      properties:
+        errorInformation:
+          $ref: ../schemas/ErrorInformation.yaml

package/sdk-scheme-adapter/v2_1_0/components/responses/partiesByIdSuccess.yaml

@@ -0,0 +1,5 @@
+description: PartiesByIdSuccess
+content:
+  application/json:
+    schema:
+      $ref: ../schemas/partiesByIdResponse.yaml

package/sdk-scheme-adapter/v2_1_0/components/responses/quotesPostSuccess.yaml

@@ -0,0 +1,5 @@
+description: sync response from POST /quotes
+content:
+  application/json:
+    schema:
+      $ref: ../schemas/quotesPostResponse.yaml

package/sdk-scheme-adapter/v2_1_0/components/responses/quotesServerError.yaml

@@ -0,0 +1,5 @@
+description: An error occurred processing the quotes request
+content:
+  application/json:
+    schema:
+      $ref: ../schemas/errorQuotesResponse.yaml

package/sdk-scheme-adapter/v2_1_0/components/responses/requestToPaySuccess.yaml

@@ -0,0 +1,5 @@
+description: Request to Pay completed successfully
+content:
+  application/json:
+    schema:
+      $ref: ../schemas/requestToPayResponse.yaml

package/sdk-scheme-adapter/v2_1_0/components/responses/requestToPayTransferBadRequest.yaml

@@ -0,0 +1,5 @@
+description: Malformed or missing required body, headers or parameters
+content:
+  application/json:
+    schema:
+      $ref: ../schemas/errorTransferResponse.yaml

package/sdk-scheme-adapter/v2_1_0/components/responses/requestToPayTransferSuccess.yaml

@@ -0,0 +1,5 @@
+description: Transfer completed successfully
+content:
+  application/json:
+    schema:
+      $ref: ../schemas/requestToPayTransferResponse.yaml

package/sdk-scheme-adapter/v2_1_0/components/responses/servicesFXPSucess.yaml

@@ -0,0 +1,5 @@
+description: The response contains participants in a scheme who offer currency conversion services. If no participants offer these services, the return object will be blank.
+content:
+  application/json:
+    schema:
+      $ref: ../../../../fspiop/v2_0/openapi3/components/schemas/ServicesFXPPutResponse.yaml

package/sdk-scheme-adapter/v2_1_0/components/responses/simpleTransfersPostSuccess.yaml

@@ -0,0 +1,5 @@
+description: sync response from POST /simpleTransfers
+content:
+  application/json:
+    schema:
+      $ref: ../schemas/simpleTransfersPostResponse.yaml

package/sdk-scheme-adapter/v2_1_0/components/responses/simpleTransfersServerError.yaml

@@ -0,0 +1,5 @@
+description: An error occurred processing the simple transfers request
+content:
+  application/json:
+    schema:
+      $ref: ../schemas/errorSimpleTransfersResponse.yaml

package/sdk-scheme-adapter/v2_1_0/components/responses/transferBadRequest.yaml

@@ -0,0 +1,5 @@
+description: Malformed or missing required body, headers or parameters
+content:
+  application/json:
+    schema:
+      $ref: ../schemas/errorTransferResponse.yaml

package/sdk-scheme-adapter/v2_1_0/components/responses/transferServerError.yaml

@@ -0,0 +1,5 @@
+description: An error occurred processing the transfer
+content:
+  application/json:
+    schema:
+      $ref: ../schemas/errorTransferResponse.yaml

package/sdk-scheme-adapter/v2_1_0/components/responses/transferSuccess.yaml

@@ -0,0 +1,5 @@
+description: Transfer completed successfully
+content:
+  application/json:
+    schema:
+      $ref: ../schemas/transferResponse.yaml

package/sdk-scheme-adapter/v2_1_0/components/responses/transferTimeout.yaml

@@ -0,0 +1,5 @@
+description: Timeout occurred processing the transfer
+content:
+  application/json:
+    schema:
+      $ref: ../schemas/errorTransferResponse.yaml

package/sdk-scheme-adapter/v2_1_0/components/schemas/Amount.yaml

@@ -0,0 +1,11 @@
+title: Amount
+type: string
+pattern: ^([0]|([1-9][0-9]{0,17}))([.][0-9]{0,3}[1-9])?$
+description: >-
+  The API data type Amount is a JSON String in a canonical format that is
+  restricted by a regular expression for interoperability reasons. This pattern
+  does not allow any trailing zeroes at all, but allows an amount without a
+  minor currency unit. It also only allows four digits in the minor currency
+  unit; a negative value is not allowed. Using more than 18 digits in the major
+  currency unit is not allowed.
+example: '123.45'

package/sdk-scheme-adapter/v2_1_0/components/schemas/AmountType.yaml

@@ -0,0 +1,14 @@
+title: AmountType
+type: string
+enum:
+  - SEND
+  - RECEIVE
+description: >-
+  Below are the allowed values for the enumeration AmountType.
+
+  - SEND - Amount the Payer would like to send, that is, the amount that should
+  be withdrawn from the Payer account including any fees.
+
+  - RECEIVE - Amount the Payer would like the Payee to receive, that is, the
+  amount that should be sent to the receiver exclusive of any fees.
+example: RECEIVE

package/sdk-scheme-adapter/v2_1_0/components/schemas/AuthenticationInfo.yaml

@@ -0,0 +1,11 @@
+title: AuthenticationInfo
+type: object
+description: Data model for the complex type AuthenticationInfo.
+properties:
+  authentication:
+    $ref: ./AuthenticationType.yaml
+  authenticationValue:
+    $ref: ./AuthenticationValue.yaml
+required:
+  - authentication
+  - authenticationValue

package/sdk-scheme-adapter/v2_1_0/components/schemas/AuthenticationType.yaml

@@ -0,0 +1,12 @@
+title: AuthenticationType
+type: string
+enum:
+  - OTP
+  - QRCODE
+  - U2F
+description: |-
+  Below are the allowed values for the enumeration AuthenticationType.
+  - OTP - One-time password generated by the Payer FSP.
+  - QRCODE - QR code used as One Time Password.
+  - U2F - U2F is a new addition isolated to Thirdparty stream.
+example: OTP

package/sdk-scheme-adapter/v2_1_0/components/schemas/AuthenticationValue.yaml

@@ -0,0 +1,44 @@
+title: AuthenticationValue
+anyOf:
+  - title: OtpValue
+    type: string
+    pattern: ^\d{3,10}$
+    description: >-
+      The API data type OtpValue is a JSON String of 3 to 10 characters,
+      consisting of digits only. Negative numbers are not allowed. One or more
+      leading zeros are allowed.
+  - title: QRCODE
+    type: string
+    minLength: 1
+    maxLength: 64
+    description: QR code used as a One Time Password.
+  - title: U2FPinValue
+    type: object
+    description: >
+      U2F challenge-response, where payer FSP verifies if the response
+      provided by end-user device matches the previously registered key.
+    properties:
+      pinValue:
+        type: string
+        pattern: ^\S{1,64}$
+        minLength: 1
+        maxLength: 64
+        description: >
+          U2F challenge-response, where payer FSP verifies if the response
+          provided by end-user device matches the previously registered key.
+      counter:
+        title: Integer
+        type: string
+        pattern: ^[1-9]\d*$
+        description: >-
+          Sequential counter used for cloning detection. Present only for U2F
+          authentication.
+    required:
+      - pinValue
+      - counter
+pattern: ^\d{3,10}$|^\S{1,64}$
+description: >-
+  Contains the authentication value. The format depends on the
+  authentication type used in the AuthenticationInfo complex type.
+
+

package/sdk-scheme-adapter/v2_1_0/components/schemas/AuthorizationIDPutResponse.yaml

@@ -0,0 +1,10 @@
+title: AuthorizationIDPutResponse
+type: object
+description: The object sent in the PUT /authorizations/{ID} callback.
+properties:
+  authenticationInfo:
+    $ref: ./AuthenticationInfo.yaml
+  responseType:
+    $ref: ./AuthorizationResponseType.yaml
+required:
+  - responseType

package/sdk-scheme-adapter/v2_1_0/components/schemas/AuthorizationResponseType.yaml

@@ -0,0 +1,12 @@
+title: AuthorizationResponseType
+type: string
+enum:
+  - ENTERED
+  - REJECTED
+  - RESEND
+description: |-
+  Below are the allowed values for the enumeration.
+  - ENTERED - Consumer entered the authentication value.
+  - REJECTED - Consumer rejected the transaction.
+  - RESEND - Consumer requested to resend the authentication value.
+example: ENTERED

package/sdk-scheme-adapter/v2_1_0/components/schemas/BalanceOfPayments.yaml

@@ -0,0 +1,9 @@
+title: BalanceOfPayments
+type: string
+pattern: ^[1-9]\d{2}$
+description: >-
+  (BopCode) The API data type
+  [BopCode](https://www.imf.org/external/np/sta/bopcode/) is a JSON String of 3
+  characters, consisting of digits only. Negative numbers are not allowed. A
+  leading zero is not allowed.
+example: '123'

package/sdk-scheme-adapter/v2_1_0/components/schemas/CorrelationId.yaml

@@ -0,0 +1,10 @@
+title: CorrelationId
+type: string
+pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
+description: >-
+  Identifier that correlates all messages of the same sequence. The API data
+  type UUID (Universally Unique Identifier) is a JSON String in canonical
+  format, conforming to [RFC 4122](https://tools.ietf.org/html/rfc4122), that is
+  restricted by a regular expression for interoperability reasons. A UUID is
+  always 36 characters long, 32 hexadecimal symbols and 4 dashes (‘-‘).
+example: b51ec534-ee48-4575-b6a9-ead2955b8069