ml-testing-toolkit 18.13.0

package/spec_files/api_definitions/central_admin_1.0/api_spec.yaml

@@ -0,0 +1,1850 @@
+openapi: 3.0.1
+info:
+  title: Central Ledger API Documentation
+  version: "1.0"
+servers:
+- url: http://127.0.0.1:3001/
+tags: []
+paths:
+  /enums:
+    get:
+      tags:
+      - enums
+      operationId: getEnums
+      responses:
+        default:
+          description: Successful
+          content:
+            '*/*':
+              schema:
+                type: string
+  /health:
+    get:
+      tags:
+      - health
+      operationId: getHealth
+      responses:
+        default:
+          description: Successful
+          content:
+            '*/*':
+              schema:
+                type: string
+  /metrics:
+    get:
+      tags:
+      - metrics
+      summary: Prometheus metrics endpoint
+      operationId: getMetrics
+      responses:
+        default:
+          description: Successful
+          content:
+            '*/*':
+              schema:
+                type: string
+  /participants:
+    get:
+      tags:
+      - participants
+      operationId: getParticipants
+      responses:
+        default:
+          description: Successful
+          content:
+            '*/*':
+              schema:
+                type: string
+    post:
+      tags:
+      - participants
+      operationId: postParticipants
+      requestBody:
+        content:
+          '*/*':
+            schema:
+              $ref: '#/components/schemas/PostParticipantsRequest'
+        required: false
+      responses:
+        default:
+          description: Successful
+          content:
+            '*/*':
+              schema:
+                type: string
+      x-codegen-request-body-name: body
+  /participants/limits:
+    get:
+      tags:
+      - participants
+      summary: View limits for all participants
+      operationId: getParticipantsLimits
+      parameters:
+      - name: currency
+        in: query
+        description: Currency code
+        schema:
+          type: string
+          enum:
+          - AED
+          - AFA
+          - AFN
+          - ALL
+          - AMD
+          - ANG
+          - AOA
+          - AOR
+          - ARS
+          - AUD
+          - AWG
+          - AZN
+          - BAM
+          - BBD
+          - BDT
+          - BGN
+          - BHD
+          - BIF
+          - BMD
+          - BND
+          - BOB
+          - BRL
+          - BSD
+          - BTN
+          - BWP
+          - BYN
+          - BZD
+          - CAD
+          - CDF
+          - CHF
+          - CLP
+          - CNY
+          - COP
+          - CRC
+          - CUC
+          - CUP
+          - CVE
+          - CZK
+          - DJF
+          - DKK
+          - DOP
+          - DZD
+          - EEK
+          - EGP
+          - ERN
+          - ETB
+          - EUR
+          - FJD
+          - FKP
+          - GBP
+          - GEL
+          - GGP
+          - GHS
+          - GIP
+          - GMD
+          - GNF
+          - GTQ
+          - GYD
+          - HKD
+          - HNL
+          - HRK
+          - HTG
+          - HUF
+          - IDR
+          - ILS
+          - IMP
+          - INR
+          - IQD
+          - IRR
+          - ISK
+          - JEP
+          - JMD
+          - JOD
+          - JPY
+          - KES
+          - KGS
+          - KHR
+          - KMF
+          - KPW
+          - KRW
+          - KWD
+          - KYD
+          - KZT
+          - LAK
+          - LBP
+          - LKR
+          - LRD
+          - LSL
+          - LTL
+          - LVL
+          - LYD
+          - MAD
+          - MDL
+          - MGA
+          - MKD
+          - MMK
+          - MNT
+          - MOP
+          - MRO
+          - MUR
+          - MVR
+          - MWK
+          - MXN
+          - MYR
+          - MZN
+          - NAD
+          - NGN
+          - NIO
+          - NOK
+          - NPR
+          - NZD
+          - OMR
+          - PAB
+          - PEN
+          - PGK
+          - PHP
+          - PKR
+          - PLN
+          - PYG
+          - QAR
+          - RON
+          - RSD
+          - RUB
+          - RWF
+          - SAR
+          - SBD
+          - SCR
+          - SDG
+          - SEK
+          - SGD
+          - SHP
+          - SLL
+          - SOS
+          - SPL
+          - SRD
+          - STD
+          - SVC
+          - SYP
+          - SZL
+          - THB
+          - TJS
+          - TMT
+          - TND
+          - TOP
+          - TRY
+          - TTD
+          - TVD
+          - TWD
+          - TZS
+          - UAH
+          - UGX
+          - USD
+          - UYU
+          - UZS
+          - VEF
+          - VND
+          - VUV
+          - WST
+          - XAF
+          - XAG
+          - XAU
+          - XCD
+          - XDR
+          - XFO
+          - XFU
+          - XOF
+          - XPD
+          - XPF
+          - XPT
+          - XTS
+          - XXX
+          - YER
+          - ZAR
+          - ZMK
+          - ZMW
+          - ZWD
+          - ZWL
+          - ZWN
+          - ZWR
+      - name: type
+        in: query
+        description: Limit Type
+        schema:
+          type: string
+      responses:
+        default:
+          description: Successful
+          content:
+            '*/*':
+              schema:
+                type: string
+  /participants/{name}:
+    get:
+      tags:
+      - participants
+      operationId: getParticipantsName
+      parameters:
+      - name: name
+        in: path
+        description: Participant name
+        required: true
+        schema:
+          type: string
+      responses:
+        default:
+          description: Successful
+          content:
+            '*/*':
+              schema:
+                type: string
+    put:
+      tags:
+      - participants
+      operationId: putParticipantsName
+      parameters:
+      - name: name
+        in: path
+        description: Participant name
+        required: true
+        schema:
+          type: string
+      requestBody:
+        content:
+          '*/*':
+            schema:
+              $ref: '#/components/schemas/ParticipantIsActive'
+        required: false
+      responses:
+        default:
+          description: Successful
+          content:
+            '*/*':
+              schema:
+                type: string
+      x-codegen-request-body-name: body
+  /participants/{name}/endpoints:
+    get:
+      tags:
+      - participants
+      summary: View participant endpoints
+      operationId: getParticipantsNameEndpoints
+      parameters:
+      - name: name
+        in: path
+        description: Name of the participant
+        required: true
+        schema:
+          maxLength: 30
+          minLength: 2
+          type: string
+          x-format:
+            alphanum: true
+        x-format:
+          alphanum: true
+      responses:
+        default:
+          description: Successful
+          content:
+            '*/*':
+              schema:
+                type: string
+    post:
+      tags:
+      - participants
+      summary: Add/Update participant endpoints
+      operationId: postParticipantsNameEndpoints
+      parameters:
+      - name: name
+        in: path
+        description: Name of the participant
+        required: true
+        schema:
+          maxLength: 30
+          minLength: 2
+          type: string
+          x-format:
+            alphanum: true
+        x-format:
+          alphanum: true
+      requestBody:
+        content:
+          '*/*':
+            schema:
+              $ref: '#/components/schemas/PostParticipantsNameEndpointsRequest'
+        required: false
+      responses:
+        default:
+          description: Successful
+          content:
+            '*/*':
+              schema:
+                type: string
+      x-codegen-request-body-name: body
+  /participants/{name}/limits:
+    get:
+      tags:
+      - participants
+      summary: View participant limits
+      operationId: getParticipantsNameLimits
+      parameters:
+      - name: name
+        in: path
+        description: Name of the participant
+        required: true
+        schema:
+          maxLength: 30
+          minLength: 2
+          type: string
+          x-format:
+            alphanum: true
+        x-format:
+          alphanum: true
+      - name: currency
+        in: query
+        description: Currency code
+        schema:
+          type: string
+          enum:
+          - AED
+          - AFA
+          - AFN
+          - ALL
+          - AMD
+          - ANG
+          - AOA
+          - AOR
+          - ARS
+          - AUD
+          - AWG
+          - AZN
+          - BAM
+          - BBD
+          - BDT
+          - BGN
+          - BHD
+          - BIF
+          - BMD
+          - BND
+          - BOB
+          - BRL
+          - BSD
+          - BTN
+          - BWP
+          - BYN
+          - BZD
+          - CAD
+          - CDF
+          - CHF
+          - CLP
+          - CNY
+          - COP
+          - CRC
+          - CUC
+          - CUP
+          - CVE
+          - CZK
+          - DJF
+          - DKK
+          - DOP
+          - DZD
+          - EEK
+          - EGP
+          - ERN
+          - ETB
+          - EUR
+          - FJD
+          - FKP
+          - GBP
+          - GEL
+          - GGP
+          - GHS
+          - GIP
+          - GMD
+          - GNF
+          - GTQ
+          - GYD
+          - HKD
+          - HNL
+          - HRK
+          - HTG
+          - HUF
+          - IDR
+          - ILS
+          - IMP
+          - INR
+          - IQD
+          - IRR
+          - ISK
+          - JEP
+          - JMD
+          - JOD
+          - JPY
+          - KES
+          - KGS
+          - KHR
+          - KMF
+          - KPW
+          - KRW
+          - KWD
+          - KYD
+          - KZT
+          - LAK
+          - LBP
+          - LKR
+          - LRD
+          - LSL
+          - LTL
+          - LVL
+          - LYD
+          - MAD
+          - MDL
+          - MGA
+          - MKD
+          - MMK
+          - MNT
+          - MOP
+          - MRO
+          - MUR
+          - MVR
+          - MWK
+          - MXN
+          - MYR
+          - MZN
+          - NAD
+          - NGN
+          - NIO
+          - NOK
+          - NPR
+          - NZD
+          - OMR
+          - PAB
+          - PEN
+          - PGK
+          - PHP
+          - PKR
+          - PLN
+          - PYG
+          - QAR
+          - RON
+          - RSD
+          - RUB
+          - RWF
+          - SAR
+          - SBD
+          - SCR
+          - SDG
+          - SEK
+          - SGD
+          - SHP
+          - SLL
+          - SOS
+          - SPL
+          - SRD
+          - STD
+          - SVC
+          - SYP
+          - SZL
+          - THB
+          - TJS
+          - TMT
+          - TND
+          - TOP
+          - TRY
+          - TTD
+          - TVD
+          - TWD
+          - TZS
+          - UAH
+          - UGX
+          - USD
+          - UYU
+          - UZS
+          - VEF
+          - VND
+          - VUV
+          - WST
+          - XAF
+          - XAG
+          - XAU
+          - XCD
+          - XDR
+          - XFO
+          - XFU
+          - XOF
+          - XPD
+          - XPF
+          - XPT
+          - XTS
+          - XXX
+          - YER
+          - ZAR
+          - ZMK
+          - ZMW
+          - ZWD
+          - ZWL
+          - ZWN
+          - ZWR
+      - name: type
+        in: query
+        description: Limit Type
+        schema:
+          type: string
+      responses:
+        default:
+          description: Successful
+          content:
+            '*/*':
+              schema:
+                type: string
+    put:
+      tags:
+      - participants
+      summary: Adjust participant limits
+      operationId: putParticipantsNameLimits
+      parameters:
+      - name: name
+        in: path
+        description: Name of the participant
+        required: true
+        schema:
+          maxLength: 30
+          minLength: 2
+          type: string
+          x-format:
+            alphanum: true
+        x-format:
+          alphanum: true
+      requestBody:
+        content:
+          '*/*':
+            schema:
+              $ref: '#/components/schemas/PutParticipantsNameLimitsRequest'
+        required: false
+      responses:
+        default:
+          description: Successful
+          content:
+            '*/*':
+              schema:
+                type: string
+      x-codegen-request-body-name: body
+  /participants/{name}/positions:
+    get:
+      tags:
+      - participants
+      summary: View participant positions
+      operationId: getParticipantsNamePositions
+      parameters:
+      - name: name
+        in: path
+        description: Name of the participant
+        required: true
+        schema:
+          maxLength: 30
+          minLength: 2
+          type: string
+          x-format:
+            alphanum: true
+        x-format:
+          alphanum: true
+      - name: currency
+        in: query
+        description: Currency code
+        schema:
+          type: string
+          enum:
+          - AED
+          - AFA
+          - AFN
+          - ALL
+          - AMD
+          - ANG
+          - AOA
+          - AOR
+          - ARS
+          - AUD
+          - AWG
+          - AZN
+          - BAM
+          - BBD
+          - BDT
+          - BGN
+          - BHD
+          - BIF
+          - BMD
+          - BND
+          - BOB
+          - BRL
+          - BSD
+          - BTN
+          - BWP
+          - BYN
+          - BZD
+          - CAD
+          - CDF
+          - CHF
+          - CLP
+          - CNY
+          - COP
+          - CRC
+          - CUC
+          - CUP
+          - CVE
+          - CZK
+          - DJF
+          - DKK
+          - DOP
+          - DZD
+          - EEK
+          - EGP
+          - ERN
+          - ETB
+          - EUR
+          - FJD
+          - FKP
+          - GBP
+          - GEL
+          - GGP
+          - GHS
+          - GIP
+          - GMD
+          - GNF
+          - GTQ
+          - GYD
+          - HKD
+          - HNL
+          - HRK
+          - HTG
+          - HUF
+          - IDR
+          - ILS
+          - IMP
+          - INR
+          - IQD
+          - IRR
+          - ISK
+          - JEP
+          - JMD
+          - JOD
+          - JPY
+          - KES
+          - KGS
+          - KHR
+          - KMF
+          - KPW
+          - KRW
+          - KWD
+          - KYD
+          - KZT
+          - LAK
+          - LBP
+          - LKR
+          - LRD
+          - LSL
+          - LTL
+          - LVL
+          - LYD
+          - MAD
+          - MDL
+          - MGA
+          - MKD
+          - MMK
+          - MNT
+          - MOP
+          - MRO
+          - MUR
+          - MVR
+          - MWK
+          - MXN
+          - MYR
+          - MZN
+          - NAD
+          - NGN
+          - NIO
+          - NOK
+          - NPR
+          - NZD
+          - OMR
+          - PAB
+          - PEN
+          - PGK
+          - PHP
+          - PKR
+          - PLN
+          - PYG
+          - QAR
+          - RON
+          - RSD
+          - RUB
+          - RWF
+          - SAR
+          - SBD
+          - SCR
+          - SDG
+          - SEK
+          - SGD
+          - SHP
+          - SLL
+          - SOS
+          - SPL
+          - SRD
+          - STD
+          - SVC
+          - SYP
+          - SZL
+          - THB
+          - TJS
+          - TMT
+          - TND
+          - TOP
+          - TRY
+          - TTD
+          - TVD
+          - TWD
+          - TZS
+          - UAH
+          - UGX
+          - USD
+          - UYU
+          - UZS
+          - VEF
+          - VND
+          - VUV
+          - WST
+          - XAF
+          - XAG
+          - XAU
+          - XCD
+          - XDR
+          - XFO
+          - XFU
+          - XOF
+          - XPD
+          - XPF
+          - XPT
+          - XTS
+          - XXX
+          - YER
+          - ZAR
+          - ZMK
+          - ZMW
+          - ZWD
+          - ZWL
+          - ZWN
+          - ZWR
+      responses:
+        default:
+          description: Successful
+          content:
+            '*/*':
+              schema:
+                type: string
+  /participants/{name}/accounts:
+    get:
+      tags:
+      - participants
+      summary: View participant accounts and balances
+      operationId: getParticipantsNameAccounts
+      parameters:
+      - name: name
+        in: path
+        description: Name of the participant
+        required: true
+        schema:
+          maxLength: 30
+          minLength: 2
+          type: string
+          x-format:
+            alphanum: true
+        x-format:
+          alphanum: true
+      responses:
+        default:
+          description: Successful
+          content:
+            '*/*':
+              schema:
+                type: string
+    post:
+      tags:
+      - participants
+      summary: Create hub accounts
+      operationId: postParticipantsNameAccounts
+      parameters:
+      - name: name
+        in: path
+        description: Participant name
+        required: true
+        schema:
+          type: string
+      requestBody:
+        content:
+          '*/*':
+            schema:
+              $ref: '#/components/schemas/PostParticipantsNameAccountsRequest'
+        required: false
+      responses:
+        default:
+          description: Successful
+          content:
+            '*/*':
+              schema:
+                type: string
+      x-codegen-request-body-name: body
+  /participants/{name}/initialPositionAndLimits:
+    post:
+      tags:
+      - participants
+      summary: Add initial participant limits and position
+      operationId: postParticipantsNameInitialpositionandlimits
+      parameters:
+      - name: name
+        in: path
+        description: Name of the participant
+        required: true
+        schema:
+          maxLength: 30
+          minLength: 2
+          type: string
+          x-format:
+            alphanum: true
+        x-format:
+          alphanum: true
+      requestBody:
+        content:
+          '*/*':
+            schema:
+              $ref: '#/components/schemas/PostInitialPositionAndLimitsRequest'
+        required: false
+      responses:
+        default:
+          description: Successful
+          content:
+            '*/*':
+              schema:
+                type: string
+      x-codegen-request-body-name: body
+  /participants/{name}/accounts/{id}:
+    put:
+      tags:
+      - participants
+      summary: Update participant accounts
+      operationId: putParticipantsNameAccountsId
+      parameters:
+      - name: name
+        in: path
+        description: Name of the participant
+        required: true
+        schema:
+          maxLength: 30
+          minLength: 2
+          type: string
+          x-format:
+            alphanum: true
+        x-format:
+          alphanum: true
+      - name: id
+        in: path
+        required: true
+        schema:
+          type: integer
+          x-constraint:
+            positive: true
+        x-constraint:
+          positive: true
+      requestBody:
+        content:
+          '*/*':
+            schema:
+              $ref: '#/components/schemas/CurrencyIsActive'
+        required: false
+      responses:
+        default:
+          description: Successful
+          content:
+            '*/*':
+              schema:
+                type: string
+      x-codegen-request-body-name: body
+    post:
+      tags:
+      - participants
+      summary: Record Funds In or Out of participant account
+      operationId: postParticipantsNameAccountsId
+      parameters:
+      - name: name
+        in: path
+        description: Name of the participant
+        required: true
+        schema:
+          maxLength: 30
+          minLength: 2
+          type: string
+          x-format:
+            alphanum: true
+        x-format:
+          alphanum: true
+      - name: id
+        in: path
+        required: true
+        schema:
+          type: integer
+          x-constraint:
+            positive: true
+        x-constraint:
+          positive: true
+      requestBody:
+        content:
+          '*/*':
+            schema:
+              $ref: '#/components/schemas/Participants'
+        required: false
+      responses:
+        default:
+          description: Successful
+          content:
+            '*/*':
+              schema:
+                type: string
+      x-codegen-request-body-name: body
+  /participants/{name}/accounts/{id}/transfers/{transferId}:
+    put:
+      tags:
+      - participants
+      summary: Record Funds In or Out of participant account
+      operationId: putParticipantsNameAccountsIdTransfersTransferid
+      parameters:
+      - name: name
+        in: path
+        description: Name of the participant
+        required: true
+        schema:
+          maxLength: 30
+          minLength: 2
+          type: string
+          x-format:
+            alphanum: true
+        x-format:
+          alphanum: true
+      - name: id
+        in: path
+        required: true
+        schema:
+          type: integer
+          x-constraint:
+            positive: true
+        x-constraint:
+          positive: true
+      - name: transferId
+        in: path
+        required: true
+        schema:
+          type: string
+          x-format:
+            guid: true
+        x-format:
+          guid: true
+      requestBody:
+        content:
+          '*/*':
+            schema:
+              $ref: '#/components/schemas/RecordFundsOut'
+        required: false
+      responses:
+        default:
+          description: Successful
+          content:
+            '*/*':
+              schema:
+                type: string
+      x-codegen-request-body-name: body
+  /ledgerAccountTypes:
+    get:
+      tags:
+      - ledgerAccountTypes
+      summary: View all ledger account types
+      operationId: getLedgerAccountTypes
+      responses:
+        default:
+          description: Successful
+          content:
+            '*/*':
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/LedgerAccountType'
+    post:
+      tags:
+      - ledgerAccountType
+      summary: Create a ledgerAccount type
+      operationId: postLedgerAccountType
+      requestBody:
+        content:
+          '*/*':
+            schema:
+              $ref: '#/components/schemas/LedgerAccountType'
+        required: true
+      responses:
+        default:
+          description: Successful
+          content:
+            '*/*':
+              schema:
+                type: string
+      x-codegen-request-body-name: body
+  /settlementModels:
+    get:
+      tags:
+      - settlementModels
+      summary: View all settlement models
+      operationId: getSettlementmodels
+      responses:
+        default:
+          description: Successful
+          content:
+            '*/*':
+              schema:
+                type: string
+    post:
+      tags:
+      - settlementModels
+      summary: Create a settlement model. This will create  any associated ledgerAccountTypes
+        for every participant that matches the settlementModel's currency
+      operationId: postSettlementmodels
+      requestBody:
+        content:
+          '*/*':
+            schema:
+              $ref: '#/components/schemas/SettlementModel'
+        required: false
+      responses:
+        default:
+          description: Successful
+          content:
+            '*/*':
+              schema:
+                type: string
+      x-codegen-request-body-name: body
+  /settlementModels/{name}:
+    get:
+      tags:
+      - settlementModels
+      summary: View settlement model by name
+      operationId: getSettlementmodelsName
+      parameters:
+      - name: name
+        in: path
+        description: SettlementModel name
+        required: true
+        schema:
+          type: string
+      responses:
+        default:
+          description: Successful
+          content:
+            '*/*':
+              schema:
+                type: string
+    put:
+      tags:
+      - settlementModels
+      summary: Update a settlement model
+      operationId: putSettlementmodelsName
+      parameters:
+      - name: name
+        in: path
+        description: settlementModel name
+        required: true
+        schema:
+          type: string
+      requestBody:
+        content:
+          '*/*':
+            schema:
+              $ref: '#/components/schemas/SettlementModelIsActive'
+        required: false
+      responses:
+        default:
+          description: Successful
+          content:
+            '*/*':
+              schema:
+                type: string
+      x-codegen-request-body-name: body
+  /transactions/{id}:
+    get:
+      tags:
+      - transaction
+      summary: Retrieve transaction details by a transferId
+      operationId: getTransfer
+      parameters:
+      - name: id
+        in: path
+        description: Transfer Id
+        required: true
+        schema:
+          type: string
+      responses:
+        default:
+          description: Successful
+          content:
+            '*/*':
+              schema:
+                $ref: '#/components/schemas/GetTransactionResponse'
+components:
+  schemas:
+    PostParticipantsRequest:
+      required:
+      - name
+      type: object
+      properties:
+        name:
+          maxLength: 30
+          minLength: 2
+          type: string
+          description: Name of the participant
+          x-format:
+            alphanum: true
+        currency:
+          $ref: '#/components/schemas/Currency'
+    PostParticipantsNameEndpointsRequest:
+      required:
+      - type
+      - value
+      type: object
+      properties:
+        type:
+          type: string
+          description: Endpoint Type
+        value:
+          type: string
+          description: Endpoint Value
+    Limit:
+      required:
+      - type
+      - value
+      type: object
+      properties:
+        type:
+          type: string
+          description: Limit Type
+        value:
+          type: number
+          description: Limit Value
+          x-constraint:
+            positive: true
+      description: Participant Limit
+    PostInitialPositionAndLimitsRequest:
+      required:
+      - limit
+      type: object
+      properties:
+        currency:
+          $ref: '#/components/schemas/Currency'
+        limit:
+          $ref: '#/components/schemas/Limit'
+        initialPosition:
+          type: number
+          description: Initial Position Value
+    PostParticipantsNameAccountsRequest:
+      required:
+      - type
+      type: object
+      properties:
+        currency:
+          $ref: '#/components/schemas/Currency'
+        type:
+          type: string
+          description: Account type
+    NoAmountProvided:
+      required:
+      - amount
+      type: object
+      properties:
+        amount:
+          type: number
+          x-constraint:
+            precision: 4
+            positive: true
+        currency:
+          $ref: '#/components/schemas/Currency'
+    Participants:
+      required:
+      - action
+      - amount
+      - externalReference
+      - reason
+      - transferId
+      type: object
+      properties:
+        transferId:
+          type: string
+          x-format:
+            guid: true
+        externalReference:
+          type: string
+        action:
+          type: string
+          enum:
+          - recordFundsIn
+          - recordFundsOutPrepareReserve
+        reason:
+          type: string
+        amount:
+          $ref: '#/components/schemas/NoAmountProvided'
+        extensionList:
+          $ref: '#/components/schemas/ExtensionList'
+    ParticipantIsActive:
+      required:
+      - isActive
+      type: object
+      properties:
+        isActive:
+          type: boolean
+          description: Participant isActive boolean
+    ParticipantLimit:
+      required:
+      - alarmPercentage
+      - type
+      - value
+      type: object
+      properties:
+        type:
+          type: string
+          description: Limit Type
+        value:
+          type: number
+          description: Limit Value
+        alarmPercentage:
+          type: number
+          description: limit threshold alarm percentage value
+      description: Participant Limit
+    PutParticipantsNameLimitsRequest:
+      required:
+      - limit
+      type: object
+      properties:
+        currency:
+          $ref: '#/components/schemas/Currency'
+        limit:
+          $ref: '#/components/schemas/ParticipantLimit'
+    CurrencyIsActive:
+      required:
+      - isActive
+      type: object
+      properties:
+        isActive:
+          type: boolean
+          description: Participant currency isActive boolean
+    RecordFundsOut:
+      required:
+      - reason
+      type: object
+      properties:
+        action:
+          type: string
+          enum:
+          - recordFundsOutCommit
+          - recordFundsOutAbort
+        reason:
+          type: string
+    LedgerAccountType:
+      required:
+      - description
+      - isActive
+      - isSettleable
+      - name
+      type: object
+      properties:
+        name:
+          maxLength: 30
+          minLength: 2
+          pattern: ^\w+$
+          type: string
+          description: Name of the ledger account type
+        description:
+          type: string
+          description: Description of the ledger account type
+        isActive:
+          type: boolean
+          description: Determines whether the ledger account is active
+        isSettleable:
+          type: boolean
+          description: Determines whether the ledger account is settleable
+    SettlementModel:
+      required:
+      - autoPositionReset
+      - currency
+      - ledgerAccountType
+      - name
+      - requireLiquidityCheck
+      - settlementAccountType
+      - settlementDelay
+      - settlementGranularity
+      - settlementInterchange
+      type: object
+      properties:
+        name:
+          maxLength: 30
+          minLength: 2
+          type: string
+          description: Name of the settlement model
+          x-format:
+            alphanum: true
+        settlementGranularity:
+          type: string
+          description: Granularity type for the settlement model GROSS or NET
+          enum:
+          - GROSS
+          - NET
+        settlementInterchange:
+          type: string
+          description: Interchange type for the settlement model BILATERAL or MULTILATERAL
+          enum:
+          - BILATERAL
+          - MULTILATERAL
+        settlementDelay:
+          type: string
+          description: Delay type for the settlement model IMMEDIATE or DEFERRED
+          enum:
+          - DEFERRED
+          - IMMEDIATE
+        currency:
+          $ref: '#/components/schemas/Currency'
+        requireLiquidityCheck:
+          type: boolean
+          description: Liquidity Check boolean
+        ledgerAccountType:
+          type: string
+          description: Account type for the settlement model
+          enum:
+          - INTERCHANGE_FEE
+          - POSITION
+        settlementAccountType:
+          type: string
+          description: 'Account type into which the settlement should be settled into
+            :  POSITION, SETTLEMENT or INTERCHANGE_FEE_SETTLEMENT'
+        autoPositionReset:
+          type: boolean
+          description: Automatic position reset setting, which determines whether
+            to execute the settlement transfer or not
+    SettlementModelIsActive:
+      required:
+      - isActive
+      type: object
+      properties:
+        isActive:
+          type: boolean
+          description: settlementModel isActive boolean
+    GetTransactionResponse:
+      title: GetTransactionResponse
+      type: object
+      properties:
+        quoteId:
+          $ref: '#/components/schemas/QuoteId'
+        transactionId:
+          $ref: '#/components/schemas/TransactionId'
+        transactionRequestId:
+          type: string
+          description: Identifies an optional previously-sent transaction request.
+        payee:
+          $ref: '#/components/schemas/Party'
+        payer:
+          $ref: '#/components/schemas/Party'
+        amount:
+          $ref: '#/components/schemas/Money'
+        transactionType:
+          $ref: '#/components/schemas/TransactionType'
+        note:
+          type: string
+          description: A memo that will be attached to the transaction.
+        extensionList:
+          $ref: '#/components/schemas/ExtensionList'
+      description: GET /transaction/{id} response object
+    QuoteId:
+      title: QuoteId
+      minLength: 1
+      pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-7][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$|^[0-9A-HJKMNP-TV-Z]{26}$
+      type: string
+      description: Quote Identifier.
+        The supported identifiers formats are for
+        lowercase [UUID](https://datatracker.ietf.org/doc/html/rfc9562) and
+        uppercase [ULID](https://github.com/ulid/spec)
+    TransactionId:
+      title: TransactionId
+      minLength: 1
+      pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-7][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$|^[0-9A-HJKMNP-TV-Z]{26}$
+      type: string
+      description: Transaction Identifier.
+        The supported identifiers formats are for
+        lowercase [UUID](https://datatracker.ietf.org/doc/html/rfc9562) and
+        uppercase [ULID](https://github.com/ulid/spec)
+    Party:
+      title: Party
+      required:
+      - partyIdInfo
+      type: object
+      properties:
+        partyIdInfo:
+          $ref: '#/components/schemas/PartyIdInfo'
+        merchantClassificationCode:
+          type: string
+          description: Used in the context of Payee Information, where the Payee happens
+            to be a merchant accepting merchant payments.
+        name:
+          type: string
+          description: Display name of the Party, could be a real name or a nick name.
+        personalInfo:
+          $ref: '#/components/schemas/PartyPersonalInfo'
+      description: Data model for the complex type Party.
+    PartyIdInfo:
+      title: PartyIdInfo
+      required:
+      - partyIdType
+      - partyIdentifier
+      type: object
+      properties:
+        partyIdType:
+          $ref: '#/components/schemas/PartyIdType'
+        partyIdentifier:
+          $ref: '#/components/schemas/PartyIdentifier'
+        partySubIdOrType:
+          type: string
+          description: A sub-identifier or sub-type for the Party.
+        fspId:
+          type: string
+          description: FSP id (if known)
+        extensionList:
+          $ref: '#/components/schemas/ExtensionList'
+      description: Data model for the complex type PartyIdInfo.
+    PartyIdType:
+      title: PartyIdTypeEnum
+      type: string
+      description: 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. The MSISDN identifier should
+        be in international format according to the ITU-T E.164 standard. Optionally,
+        the MSISDN may be prefixed by a single plus sign, indicating the international
+        prefix. - EMAIL An email is used as reference to a participant. The format
+        of the email should be according to the informational RFC 3696. - PERSONAL_ID
+        A personal identifier is used as reference to a participant. Examples of personal
+        identification are passport number, birth certificate number, and national
+        registration number. The identifier number is added in the PartyIdentifier
+        element. The personal identifier type is added in the PartySubIdOrType element.
+        - BUSINESS A specific Business (for example, an organization or a company)
+        is used as reference to a participant. The BUSINESS identifier can be in any
+        format. To make a transaction connected to a specific username or bill number
+        in a Business, the PartySubIdOrType element should be used. - DEVICE A specific
+        device (for example, a POS or ATM) id connected to a specific business or
+        organization is used as reference to a Party. For referencing a specific device
+        under a specific business or organization, use the PartySubIdOrType element.
+        - ACCOUNT_ID A bank account number or FSP account id should be used as reference
+        to a participant. The ACCOUNT_ID identifier can be in any format, as formats
+        can greatly differ depending on country and FSP. - IBAN A bank account number
+        or FSP account id is used as reference to a participant. The IBAN identifier
+        can consist of up to 34 alphanumeric characters and should be entered without
+        whitespace. - ALIAS An alias is used as reference to a participant. The alias
+        should be created in the FSP as an alternative reference to an account owner.
+        Another example of an alias is a username in the FSP system. 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.
+      enum:
+      - MSISDN
+      - EMAIL
+      - PERSONAL_ID
+      - BUSINESS
+      - DEVICE
+      - ACCOUNT_ID
+      - IBAN
+      - ALIAS
+    PartyIdentifier:
+      title: PartyIdentifier
+      maxLength: 128
+      minLength: 1
+      type: string
+      description: Identifier of the Party.
+    ExtensionList:
+      title: ExtensionList
+      required:
+      - extension
+      type: object
+      properties:
+        extension:
+          maxItems: 16
+          minItems: 1
+          type: array
+          description: Number of Extension elements
+          items:
+            $ref: '#/components/schemas/Extension'
+      description: Data model for the complex type ExtensionList
+    Extension:
+      title: Extension
+      required:
+      - key
+      - value
+      type: object
+      properties:
+        key:
+          type: string
+          description: Extension key.
+        value:
+          type: string
+          description: Extension value.
+      description: Data model for the complex type Extension
+    PartyPersonalInfo:
+      title: PartyPersonalInfo
+      type: object
+      properties:
+        complexName:
+          $ref: '#/components/schemas/PartyComplexName'
+        dateOfBirth:
+          type: string
+          description: Date of birth for the Party.
+      description: Data model for the complex type PartyPersonalInfo.
+    PartyComplexName:
+      title: PartyComplexName
+      type: object
+      properties:
+        firstName:
+          type: string
+          description: Party’s first name.
+        middleName:
+          type: string
+          description: Party’s middle name.
+        lastName:
+          type: string
+          description: Party’s last name.
+      description: Data model for the complex type PartyComplexName.
+    TransactionType:
+      title: TransactionType
+      required:
+      - initiator
+      - initiatorType
+      - scenario
+      type: object
+      properties:
+        scenario:
+          type: string
+          description: Deposit, withdrawal, refund, …
+        subScenario:
+          type: string
+          description: Possible sub-scenario, defined locally within the scheme.
+        initiator:
+          type: string
+          description: Who is initiating the transaction - Payer or Payee
+        initiatorType:
+          type: string
+          description: Consumer, agent, business, …
+        refundInfo:
+          $ref: '#/components/schemas/Refund'
+        balanceOfPayments:
+          type: string
+          description: Balance of Payments code.
+      description: Data model for the complex type TransactionType.
+    Refund:
+      title: Refund
+      required:
+      - originalTransactionId
+      type: object
+      properties:
+        originalTransactionId:
+          type: string
+          description: Reference to the original transaction id that is requested
+            to be refunded.
+        refundReason:
+          type: string
+          description: Free text indicating the reason for the refund.
+      description: Data model for the complex type Refund.
+    Money:
+      title: Money
+      required:
+      - amount
+      - currency
+      type: object
+      properties:
+        currency:
+          $ref: '#/components/schemas/Currency'
+        amount:
+          $ref: '#/components/schemas/Amount'
+      description: Data model for the complex type Money.
+    Currency:
+      title: CurrencyEnum
+      maxLength: 3
+      minLength: 3
+      type: string
+      description: The currency codes defined in ISO 4217 as three-letter alphabetic
+        codes are used as the standard naming representation for currencies.
+      enum:
+      - AED
+      - AFN
+      - ALL
+      - AMD
+      - ANG
+      - AOA
+      - ARS
+      - AUD
+      - AWG
+      - AZN
+      - BAM
+      - BBD
+      - BDT
+      - BGN
+      - BHD
+      - BIF
+      - BMD
+      - BND
+      - BOB
+      - BRL
+      - BSD
+      - BTN
+      - BWP
+      - BYN
+      - BZD
+      - CAD
+      - CDF
+      - CHF
+      - CLP
+      - CNY
+      - COP
+      - CRC
+      - CUC
+      - CUP
+      - CVE
+      - CZK
+      - DJF
+      - DKK
+      - DOP
+      - DZD
+      - EGP
+      - ERN
+      - ETB
+      - EUR
+      - FJD
+      - FKP
+      - GBP
+      - GEL
+      - GGP
+      - GHS
+      - GIP
+      - GMD
+      - GNF
+      - GTQ
+      - GYD
+      - HKD
+      - HNL
+      - HRK
+      - HTG
+      - HUF
+      - IDR
+      - ILS
+      - IMP
+      - INR
+      - IQD
+      - IRR
+      - ISK
+      - JEP
+      - JMD
+      - JOD
+      - JPY
+      - KES
+      - KGS
+      - KHR
+      - KMF
+      - KPW
+      - KRW
+      - KWD
+      - KYD
+      - KZT
+      - LAK
+      - LBP
+      - LKR
+      - LRD
+      - LSL
+      - LYD
+      - MAD
+      - MDL
+      - MGA
+      - MKD
+      - MMK
+      - MNT
+      - MOP
+      - MRO
+      - MUR
+      - MVR
+      - MWK
+      - MXN
+      - MYR
+      - MZN
+      - NAD
+      - NGN
+      - NIO
+      - NOK
+      - NPR
+      - NZD
+      - OMR
+      - PAB
+      - PEN
+      - PGK
+      - PHP
+      - PKR
+      - PLN
+      - PYG
+      - QAR
+      - RON
+      - RSD
+      - RUB
+      - RWF
+      - SAR
+      - SBD
+      - SCR
+      - SDG
+      - SEK
+      - SGD
+      - SHP
+      - SLL
+      - SOS
+      - SPL
+      - SRD
+      - STD
+      - SVC
+      - SYP
+      - SZL
+      - THB
+      - TJS
+      - TMT
+      - TND
+      - TOP
+      - TRY
+      - TTD
+      - TVD
+      - TWD
+      - TZS
+      - UAH
+      - UGX
+      - USD
+      - UYU
+      - UZS
+      - VEF
+      - VND
+      - VUV
+      - WST
+      - XAF
+      - XCD
+      - XDR
+      - XOF
+      - XPF
+      - XTS
+      - XXX
+      - YER
+      - ZAR
+      - ZMW
+      - ZWD
+    Amount:
+      title: Amount
+      pattern: ^([0]|([1-9][0-9]{0,17}))([.][0-9]{0,3}[1-9])?$
+      type: string
+      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.