openapi: 3.1.0
info:
  title: Internal RBA WS Admin
  description: Rest RBA Admin Config Operations
  version: "25R2_1.0"
paths:
  # Get authtypes by service
  /admin/authtypes/{service}:
    get:
      tags:
        - authType
      summary: Retrieve all authentication types of rule.
      description: |
        Retrieve all authentication types of rule.
      operationId: getAuthTypeList
      parameters:
        - name: service
          in: path
          description: Service code
          required: true
          schema:
            type: string
            minLength: 1
            maxLength: 255
            pattern: '^[A-Z\d]{3}_[A-Z\d]{3}(?:_[A-Z\d]+)*$'
          example: HUB_NRT
      responses:
        "200":
          description: Default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthTypeListResponse'
  # Blacklist API definition
  /admin/blacklist/create:
    post:
      tags:
        - blacklist
      summary: Create blackList element.
      description: |
        Create a blacklist element. Type and Value are validated. 
        Control that it doesn't exist, otherwise return an error.
      operationId: createBlackList
      requestBody:
        description: Blacklist object to create
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BlacklistDTO'
        required: true
      responses:
        "200":
          description: Default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RbaAdminResponseOneBL'
  /admin/blacklist/getAll/{service}/{page}:
    get:
      tags:
        - blacklist
      summary: Get all blackListed elements.
      description: |
        Get all blackListed elements.
      operationId: getAllBlackLists
      parameters:
        - name: service
          in: path
          description: Service code
          required: true
          schema:
            type: string
            minLength: 1
            maxLength: 255
            pattern: '^[A-Z\d]{3}_[A-Z\d]{3}(?:_[A-Z\d]+)*$'
          example: HUB_NRT
        - name: page
          in: path
          description: Page
          required: true
          schema:
            type: integer
            format: int32
            min: 0
          example: 0
      responses:
        "200":
          description: Default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RbaAdminResponseListBL'
  /admin/blacklist/{service}/{types}/{page}:
    get:
      tags:
        - blacklist
      summary: "Search blackListed elements by service, type and value or label."
      description: |
        Search blackListed elements by type and value or label. It's possible
           to filter by issuer or sub-issuer. If the request is invalid, the following\
           error will be returned:
      operationId: searchServiceBlackLists
      parameters:
        - name: service
          in: path
          description: Service code
          required: true
          schema:
            type: string
            minLength: 1
            maxLength: 255
            pattern: '^[A-Z\d]{3}_[A-Z\d]{3}(?:_[A-Z\d]+)*$'
          example: HUB_NRT
        - name: types
          in: path
          description: "Blacklist types: PHONE, IP, CARD_BLACK ..."
          required: true
          schema:
            type: string
          example: PHONE,IP
        - name: page
          in: path
          description: Page number
          required: true
          schema:
            type: integer
            format: int32
            min: 0
          example: 0
        - name: searchBy
          in: query
          description: "Where to search the value, Possible values: value or label"
          required: true
          schema:
            type: string
          example: label
        - name: value
          in: query
          description: Value to search either among labels or values
          required: true
          schema:
            type: string
          example: labelValue
        - name: bcf
          in: query
          description: Issuer Code
          schema:
            type: string
          example: 66666
        - name: bdom
          in: query
          description: SubIssuer Code
          schema:
            type: string
          example: 66666
        - name: size
          in: query
          description: Page size (elements per page)
          required: true
          schema:
            type: integer
            format: int32
            min: 1
          example: 10
      responses:
        "200":
          description: Default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RbaAdminResponseListBL'
  /admin/blacklist/{service}/{types}:
    get:
      tags:
        - blacklist
      summary: "Search blackListed elements by service, type and value or label."
      description: |
        Search blackListed elements by type and value or label. It's possible
           to filter by issuer or sub-issuer. If the request is invalid, the following
           error will be returned:
      operationId: searchServiceBlackLists_1
      parameters:
        - name: service
          in: path
          description: Service code
          required: true
          schema:
            type: string
            minLength: 1
            maxLength: 255
            pattern: '^[A-Z\d]{3}_[A-Z\d]{3}(?:_[A-Z\d]+)*$'
          example: HUB_NRT
        - name: types
          in: path
          description: "Blacklist types: PHONE, IP, CARD_BLACK ..."
          required: true
          schema:
            type: string
            min: 1
          example: PHONE,IP
        - name: searchBy
          in: query
          description: "Where to search the value, Possible values: value or label"
          required: true
          schema:
            type: string
          example: label
        - name: value
          in: query
          description: Value to search either among labels or values
          required: true
          schema:
            type: string
          example: labelValue
        - name: bcf
          in: query
          description: Issuer Code
          schema:
            type: string
          example: 66666
        - name: bdom
          in: query
          description: SubIssuer Code
          schema:
            type: string
          example: 66666
      responses:
        "200":
          description: Default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RbaAdminResponseListBL'
  /admin/blacklist/delete:
    delete:
      tags:
        - blacklist
      summary: Delete blackList element.
      description: |
        Delete blackList element. The request object is validated
      operationId: deleteBlacklistItem
      requestBody:
        description: The blacklist item to delete
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BlacklistDTO'
        required: true
      responses:
        "204":
          description: OK
        "400":
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                description: MessageContext
                properties:
                  origin:
                    type: string
                    examples:
                      - LOCAL
                  originVersion:
                    type: string
                    examples:
                      - 25R1Q-P-03-SNAPSHOT
                  originHost:
                    type: string
                    examples:
                      - edc9d5c538d7
                  requestId:
                    type: string
                    examples:
                      - 36388b6f-df09-4005-abda-4d0af277e44a
                  service:
                    type: string
                    examples:
                      - HUB_BLC
                  lastEventCode:
                    type: string
                    description: |
                      Here is the list of defined functional error codes and their meaning:
                      <details>
                        <summary>Click to expand</summary>
                        | Error code | Description |
                        | --- | --- |
                        | 400010005 | Bad parameter |
                        | 400050002 | Bad parameter : Blacklist Type |
                        | 400050003 | Bad parameter : Blacklist Value |
                        | 400050004 | Bad parameter : Incoherent IP Range |
                      </details>
                    examples:
                      - 400050002
                  privateAPI:
                    type: boolean
                    examples:
                      - false
        "403":
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                description: MessageContext
                properties:
                  origin:
                    type: string
                    examples:
                      - LOCAL
                  originVersion:
                    type: string
                    examples:
                      - 25R1Q-P-03-SNAPSHOT
                  originHost:
                    type: string
                    examples:
                      - edc9d5c538d7
                  requestId:
                    type: string
                    examples:
                      - 36388b6f-df09-4005-abda-4d0af277e44a
                  service:
                    type: string
                    examples:
                      - HUB_BLC
                  lastEventCode:
                    type: string
                    description: |
                      Here is the list of defined functional error codes and their meaning:
                      <details>
                        <summary>Click to expand</summary>
                        | Error code | Description |
                        | --- | --- |
                        | 403000000 | The provided Api-Key is invalid or expired |
                      </details>
                    examples:
                      - 403000000
                  privateAPI:
                    type: boolean
                    examples:
                      - false


        "404":
          description: Not found
          content:
            application/json:
              schema:
                type: object
                description: MessageContext
                properties:
                  origin:
                    type: string
                    examples:
                      - LOCAL
                  originVersion:
                    type: string
                    examples:
                      - 25R1Q-P-03-SNAPSHOT
                  originHost:
                    type: string
                    examples:
                      - edc9d5c538d7
                  requestId:
                    type: string
                    examples:
                      - 36388b6f-df09-4005-abda-4d0af277e44a
                  service:
                    type: string
                    examples:
                      - HUB_BLC
                  lastEventCode:
                    type: string
                    description: |
                      Here is the list of defined functional error codes and their meaning:
                      <details>
                        <summary>Click to expand</summary>
                        | Error code | Description |
                        | --- | --- |
                        | 404040000 | Blacklist element not found |
                      </details>
                    examples:
                      - 404040000
                  privateAPI:
                    type: boolean
                    examples:
                      - false
  /admin/blacklist/update:
    put:
      tags:
        - blacklist
      summary: Update blackList element.
      description: |
        Update blackList element.
      operationId: updateBlacklist
      requestBody:
        description: The updated blacklist item to persist
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BlacklistDTO'
        required: true
      responses:
        "200":
          description: OK
        "400":
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                description: MessageContext
                properties:
                  origin:
                    type: string
                    examples:
                      - LOCAL
                  originVersion:
                    type: string
                    examples:
                      - 25R1Q-P-03-SNAPSHOT
                  originHost:
                    type: string
                    examples:
                      - edc9d5c538d7
                  requestId:
                    type: string
                    examples:
                      - 36388b6f-df09-4005-abda-4d0af277e44a
                  service:
                    type: string
                    examples:
                      - HUB_BLC
                  lastEventCode:
                    type: string
                    description: |
                      Here is the list of defined functional error codes and their meaning:
                      <details>
                        <summary>Click to expand</summary>
                        | Error code | Description |
                        | --- | --- |
                        | 400010005 | Bad parameter |
                        | 400050002 | Bad parameter : Blacklist Type |
                        | 400050003 | Bad parameter : Blacklist Value |
                        | 400050004 | Bad parameter : Incoherent IP Range |
                      </details>
                    examples:
                      - 400050002
                  privateAPI:
                    type: boolean
                    examples:
                      - false
        "403":
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                description: MessageContext
                properties:
                  origin:
                    type: string
                    examples:
                      - LOCAL
                  originVersion:
                    type: string
                    examples:
                      - 25R1Q-P-03-SNAPSHOT
                  originHost:
                    type: string
                    examples:
                      - edc9d5c538d7
                  requestId:
                    type: string
                    examples:
                      - 36388b6f-df09-4005-abda-4d0af277e44a
                  service:
                    type: string
                    examples:
                      - HUB_BLC
                  lastEventCode:
                    type: string
                    description: |
                      Here is the list of defined functional error codes and their meaning:
                      <details>
                        <summary>Click to expand</summary>
                        | Error code | Description |
                        | --- | --- |
                        | 403000000 | The provided Api-Key is invalid or expired |
                      </details>
                    examples:
                      - 400050002
                  privateAPI:
                    type: boolean
                    examples:
                      - false
  /admin/blacklist/{service}/{types}/count:
    get:
      tags:
        - blacklist
      summary: "Count blackListed elements by service, type and value or label."
      description: |
        count blackListed elements by type and value or label. It's possible
           to filter by issuer or sub-issuer.
      operationId: countServiceBlackLists
      parameters:
        - name: service
          in: path
          description: Service code
          required: true
          schema:
            type: string
            minLength: 1
            maxLength: 255
            pattern: '^[A-Z\d]{3}_[A-Z\d]{3}(?:_[A-Z\d]+)*$'
          example: HUB_NRT
        - name: types
          in: path
          description: "Blacklist types: PHONE, IP, CARD_BLACK ..."
          required: true
          schema:
            type: string
            min: 1
          example: PHONE,IP
        - name: searchBy
          in: query
          description: "Where to search the value, Possible values: value or label"
          required: true
          schema:
            type: string
          example: label
        - name: value
          in: query
          description: Value to search either among labels or values
          required: true
          schema:
            type: string
          example: labelValue
        - name: bcf
          in: query
          description: Issuer Code
          schema:
            type: string
          example: 66666
        - name: bdom
          in: query
          description: SubIssuer Code
          schema:
            type: string
          example: 66666
      responses:
        "200":
          description: Default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RbaAdminResponseCount'
  /admin/blacklisted:
    get:
      tags:
        - blacklist
      summary: Check if value is blacklisted.
      description: |
        Service to check if value is blacklisted.
      operationId: isBlackListed
      parameters:
        - name: service
          in: query
          description: Service code
          required: true
          schema:
            type: string
            minLength: 1
            maxLength: 255
            pattern: '^[A-Z\d]{3}_[A-Z\d]{3}(?:_[A-Z\d]+)*$'
          example: HUB_NRT
        - name: type
          in: query
          description: Value type.
          required: true
          schema:
            type: string
            enum:
              - IP
              - IPV6
              - IP_RANGE
              - IPV6_RANGE
              - EMAIL
              - PHONE
              - CARD_BLACK
              - CARD_WHITE
              - CARD_EXEMPTION
              - MERCHANT_URL
              - MERCHANT_COUNTRY
              - MERCHANT_ID
              - MERCHANT_NAME
              - MERCHANT_DOMAIN
              - RCPT_COUNTRY
          example: PHONE
        - name: value
          in: query
          description: Value to check.
          required: true
          schema:
            type: string
          example: value
      responses:
        "200":
          description: Default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RbaAdminResponseServiceBoolean'
  # Service create
  /admin/service/create:
    post:
      tags:
        - service
      summary: Create service element
      description: |
        Create service element
      operationId: createService
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ServiceDTO'
      responses:
        "200":
          description: Default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RbaAdminResponseServiceServiceDTO'
  # Configs API definition
  /admin/config:
    put:
      tags:
        - config
      summary: Update config element.
      description: |
        Update config element. The request object is validated.
      operationId: updateConfig
      requestBody:
        description: The updated config item to persist
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConfigDTO'
        required: true
      responses:
        "200":
          description: Default response
        "400":
          description: Bad request
          content:
            application/json:
              schema:
                type: object
                description: MessageContext
                properties:
                  origin:
                    type: string
                    examples:
                      - LOCAL
                  originVersion:
                    type: string
                    examples:
                      - 25R1Q-P-03-SNAPSHOT
                  originHost:
                    type: string
                    examples:
                      - edc9d5c538d7
                  requestId:
                    type: string
                    examples:
                      - 36388b6f-df09-4005-abda-4d0af277e44a
                  service:
                    type: string
                    examples:
                      - HUB_BLC
                  lastEventCode:
                    type: string
                    description: |
                      Here is the list of defined functional error codes and their meaning:
                      <details>
                        <summary>Click to expand</summary>
                        | Error code | Description |
                        | --- | --- |
                        | 400010005 | Bad parameter : service |
                        | 400090051 | Bad parameter : Undefined config. |
                        | 400090052 | Bad parameter : Undefined config ID |
                        | 400090053 | Bad parameter : Undefined config Service |
                        | 400090054 | Bad parameter : Undefined config Issuer |
                        | 400090056 | Bad parameter : Undefined config entry |
                        | 400090058 | Bad parameter : Invalid config value duration: number(3) |
                        | 400090057 | Bad parameter : Invalid config value :boolean |
                      </details>
                    examples:
                      - 400050002
                  privateAPI:
                    type: boolean
                    examples:
                      - false
        "403":
          description: Bad request
          content:
            application/json:
              schema:
                type: object
                description: MessageContext
                properties:
                  origin:
                    type: string
                    examples:
                      - LOCAL
                  originVersion:
                    type: string
                    examples:
                      - 25R1Q-P-03-SNAPSHOT
                  originHost:
                    type: string
                    examples:
                      - edc9d5c538d7
                  requestId:
                    type: string
                    examples:
                      - 36388b6f-df09-4005-abda-4d0af277e44a
                  service:
                    type: string
                    examples:
                      - HUB_BLC
                  lastEventCode:
                    type: string
                    description: |
                      Here is the list of defined functional error codes and their meaning:
                      <details>
                        <summary>Click to expand</summary> 
                        | Error code | Description |
                        | --- | --- |
                        | 403000000 | The provided Api-Key is invalid or expired. |
                      </details>
                    examples:
                      - 403000000
                  privateAPI:
                    type: boolean
                    examples:
                      - false
        "404":
          description: Not found
          content:
            application/json:
              schema:
                type: object
                description: MessageContext
                properties:
                  origin:
                    type: string
                    examples:
                      - LOCAL
                  originVersion:
                    type: string
                    examples:
                      - 25R1Q-P-03-SNAPSHOT
                  originHost:
                    type: string
                    examples:
                      - edc9d5c538d7
                  requestId:
                    type: string
                    examples:
                      - 36388b6f-df09-4005-abda-4d0af277e44a
                  service:
                    type: string
                    examples:
                      - HUB_BLC
                  lastEventCode:
                    type: string
                    description: |
                      Here is the list of defined functional error codes and their meaning:
                      <details>
                        <summary>Click to expand</summary> 
                        | Error code | Description |
                        | --- | --- |
                        | 404060009 | Config element not found |
                      </details>
                    examples:
                      - 404060009
                  privateAPI:
                    type: boolean
                    examples:
                      - false
        "520":
          description: Unexpected error
          content:
            application/json:
              schema:
                type: object
                description: MessageContext
                properties:
                  origin:
                    type: string
                    examples:
                      - LOCAL
                  originVersion:
                    type: string
                    examples:
                      - 25R1Q-P-03-SNAPSHOT
                  originHost:
                    type: string
                    examples:
                      - edc9d5c538d7
                  requestId:
                    type: string
                    examples:
                      - 36388b6f-df09-4005-abda-4d0af277e44a
                  service:
                    type: string
                    examples:
                      - HUB_BLC
                  lastEventCode:
                    type: string
                    description: |
                      Here is the list of defined functional error codes and their meaning:
                      <details>
                        <summary>Click to expand</summary> 
                        | Error code | Description |
                        | --- | --- |
                        | 520000000 | Unexpected error |
                      </details>
                    examples:
                      - 520000000
                  privateAPI:
                    type: boolean
                    examples:
                      - false
    post:
      tags:
        - config
      summary: Create config element.
      description: |
        Create config element. All required parameters are validated.
      operationId: createConfig
      requestBody:
        description: Config object to create
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConfigDTO'
        required: true
      responses:
        "200":
          description: Default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfigResponse'
    delete:
      tags:
        - config
      summary: Delete config element.
      description: |
        Delete config element.
      operationId: deleteConfig
      requestBody:
        description: The ID of config item to delete
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConfigDTO'
        required: true
      responses:
        "200":
          description: Default response
        "400":
          description: Bad request
          content:
            application/json:
              schema:
                type: object
                description: MessageContext
                properties:
                  origin:
                    type: string
                    examples:
                      - LOCAL
                  originVersion:
                    type: string
                    examples:
                      - 25R1Q-P-03-SNAPSHOT
                  originHost:
                    type: string
                    examples:
                      - edc9d5c538d7
                  requestId:
                    type: string
                    examples:
                      - 36388b6f-df09-4005-abda-4d0af277e44a
                  service:
                    type: string
                    examples:
                      - HUB_BLC
                  lastEventCode:
                    type: string
                    description: |
                      Here is the list of defined functional error codes and their meaning:
                      <details>
                        <summary>Click to expand</summary>
                        | Error code | Description |
                        | --- | --- |
                        | 400010010 | Bad parameter : issuer code. |
                      </details>
                    examples:
                      - 400010010
                  privateAPI:
                    type: boolean
                    examples:
                      - false
        "403":
          description: Bad request
          content:
            application/json:
              schema:
                type: object
                description: MessageContext
                properties:
                  origin:
                    type: string
                    examples:
                      - LOCAL
                  originVersion:
                    type: string
                    examples:
                      - 25R1Q-P-03-SNAPSHOT
                  originHost:
                    type: string
                    examples:
                      - edc9d5c538d7
                  requestId:
                    type: string
                    examples:
                      - 36388b6f-df09-4005-abda-4d0af277e44a
                  service:
                    type: string
                    examples:
                      - HUB_BLC
                  lastEventCode:
                    type: string
                    description: |
                      Here is the list of defined functional error codes and their meaning:
                      <details>
                        <summary>Click to expand</summary>
                        | Error code | Description |
                        | --- | --- |
                        | 403000000 | The provided Api-Key is invalid or expired. |
                      </details>
                    examples:
                      - 403000000
                  privateAPI:
                    type: boolean
                    examples:
                      - false
        "404":
          description: Not found
          content:
            application/json:
              schema:
                type: object
                description: MessageContext
                properties:
                  origin:
                    type: string
                    examples:
                      - LOCAL
                  originVersion:
                    type: string
                    examples:
                      - 25R1Q-P-03-SNAPSHOT
                  originHost:
                    type: string
                    examples:
                      - edc9d5c538d7
                  requestId:
                    type: string
                    examples:
                      - 36388b6f-df09-4005-abda-4d0af277e44a
                  service:
                    type: string
                    examples:
                      - HUB_BLC
                  lastEventCode:
                    type: string
                    description: |
                      Here is the list of defined functional error codes and their meaning:
                      <details>
                        <summary>Click to expand</summary>
                        | Error code | Description |
                        | --- | --- |
                        | 404060009 | Config element not found |
                      </details>
                    examples:
                      - 404060009
                  privateAPI:
                    type: boolean
                    examples:
                      - false
        "520":
          description: Unexpected error
          content:
            application/json:
              schema:
                type: object
                description: MessageContext
                properties:
                  origin:
                    type: string
                    examples:
                      - LOCAL
                  originVersion:
                    type: string
                    examples:
                      - 25R1Q-P-03-SNAPSHOT
                  originHost:
                    type: string
                    examples:
                      - edc9d5c538d7
                  requestId:
                    type: string
                    examples:
                      - 36388b6f-df09-4005-abda-4d0af277e44a
                  service:
                    type: string
                    examples:
                      - HUB_BLC
                  lastEventCode:
                    type: string
                    description: |
                      Here is the list of defined functional error codes and their meaning:
                      <details>
                        <summary>Click to expand</summary>
                        | Error code | Description |
                        | --- | --- |
                        | 520000000 | Unexpected error |
                      </details>
                    examples:
                      - 520000000
                  privateAPI:
                    type: boolean
                    examples:
                      - false
  /admin/config/{service}:
    get:
      tags:
        - config
      summary: Get all config elements.
      description: |
        Get all config elements.
      operationId: getAllConfigs
      parameters:
        - name: service
          in: path
          description: Service code
          required: true
          schema:
            type: string
            minLength: 1
            maxLength: 255
            pattern: '^[A-Z\d]{3}_[A-Z\d]{3}(?:_[A-Z\d]+)*$'
          example: HUB_NRT
      responses:
        "200":
          description: Default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfigListResponse'
  # CTA counters API definition
  /admin/counters:
    post:
      tags:
        - counters
      summary: Get all counters.
      description: |
        Get all counters.
      operationId: getCounters
      requestBody:
        description: TransactionActivity request
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TransactionActivityRequest'
        required: true
      responses:
        "200":
          description: Default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CTACountersResponse'
  # Eligible merchant API definition
  /admin/eligible-merchant/search:
    post:
      tags:
        - eligibleMerchant
      summary: Search eligible merchants.
      description: |
        Will return search results and a count of all active (not deleted)
        merchants.
      operationId: searchEligibleMerchants
      requestBody:
        description: SearchEligibleMerchantsRequestDTO
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SearchEligibleMerchantsRequestDTO'
        required: true
      responses:
        "200":
          description: Default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EligibleMerchantListResponse'
  /admin/eligible-merchant/search-by-payee:
    post:
      tags:
        - eligibleMerchant
      summary: Search eligible merchants by like operation.
      description: |
        Will return search results and a count of all active (not deleted)
        merchants.
      operationId: searchEligibleMerchantsByPayee
      requestBody:
        description: SearchEligibleMerchantsByPayeeRequestDTO
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SearchEligibleMerchantsByPayeeRequestDTO'
        required: true
      responses:
        "200":
          description: Default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EligibleMerchantListResponse'
  /admin/eligible-merchant/update:
    put:
      tags:
        - eligibleMerchant
      summary: Update eligible merchant.
      description: |
        If eligible merchant not found or already exists with the same
         service/issuer/subIssuer/type/vale, exception will be thrown
      operationId: updateEligibleMerchant
      requestBody:
        description: UpdateEligibleMerchantRequestDTO
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateEligibleMerchantRequestDTO'
        required: true
      responses:
        "200":
          description: Default response
        "400":
          description: Bad request
          content:
            application/json:
              schema:
                type: object
                description: MessageContext
                properties:
                  origin:
                    type: string
                    examples:
                      - LOCAL
                  originVersion:
                    type: string
                    examples:
                      - 25R1Q-P-03-SNAPSHOT
                  originHost:
                    type: string
                    examples:
                      - edc9d5c538d7
                  requestId:
                    type: string
                    examples:
                      - 36388b6f-df09-4005-abda-4d0af277e44a
                  service:
                    type: string
                    examples:
                      - HUB_BLC
                  lastEventCode:
                    type: string
                    description: |
                      Here is the list of defined functional error codes and their meaning:
                      <details>
                        <summary>Click to expand</summary>
                        | Error code | Description |
                        | --- | --- |
                        | 400010005 | Bad parameter : service |
                        | 400090082 | Bad parameter : Undefined eligible merchant |
                        | 400090083 | Bad parameter : Undefined eligible merchant id |
                        | 400090084 | Bad parameter : Undefined eligible merchant service |
                        | 400090085 | Bad parameter : Undefined eligible merchant issuer |
                        | 400090086 | Bad parameter : Undefined eligible merchant payee type |
                        | 400090087 | Bad parameter : Undefined eligible merchant payee |
                        | 400090089 | Bad parameter : Eligible merchant already exists |
                        | 400100000 | Bad request : Invalid incoming request |
                        | 400010010 | Bad parameter : issuer code |
                        | 400010011 | Bad parameter : subIssuer code |
                      </details>
                    examples:
                      - 400050002
                  privateAPI:
                    type: boolean
                    examples:
                      - false
        "403":
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                description: MessageContext
                properties:
                  origin:
                    type: string
                    examples:
                      - LOCAL
                  originVersion:
                    type: string
                    examples:
                      - 25R1Q-P-03-SNAPSHOT
                  originHost:
                    type: string
                    examples:
                      - edc9d5c538d7
                  requestId:
                    type: string
                    examples:
                      - 36388b6f-df09-4005-abda-4d0af277e44a
                  service:
                    type: string
                    examples:
                      - HUB_BLC
                  lastEventCode:
                    type: string
                    description: |
                      Here is the list of defined functional error codes and their meaning:
                      <details>
                        <summary>Click to expand</summary>
                        | Error code | Description |
                        | --- | --- |
                        | 403000000 | The provided Api-Key is invalid or expired. |
                      </details>
                    examples:
                      - 403000000
                  privateAPI:
                    type: boolean
                    examples:
                      - false
        "520":
          description: Unexpected error
          content:
            application/json:
              schema:
                type: object
                description: MessageContext
                properties:
                  origin:
                    type: string
                    examples:
                      - LOCAL
                  originVersion:
                    type: string
                    examples:
                      - 25R1Q-P-03-SNAPSHOT
                  originHost:
                    type: string
                    examples:
                      - edc9d5c538d7
                  requestId:
                    type: string
                    examples:
                      - 36388b6f-df09-4005-abda-4d0af277e44a
                  service:
                    type: string
                    examples:
                      - HUB_BLC
                  lastEventCode:
                    type: string
                    description: |
                      Here is the list of defined functional error codes and their meaning:
                      <details>
                        <summary>Click to expand</summary>
                        | Error code | Description |
                        | --- | --- |
                        | 520000000 | Unexpected error |
                      </details>
                    examples:
                      - 400050002
                  privateAPI:
                    type: boolean
                    examples:
                      - false
  # Issuer configs API definition
  /admin/issuerconfig:
    put:
      tags:
        - issuerConfig
      summary: Update an issuer config.
      description: |
        Update an issuer config.
      operationId: updateIssuerConfig
      requestBody:
        description: The updated issuer config item to persist
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IssuerConfigDTO'
        required: true
      responses:
        "200":
          description: Default response
        "400":
          description: Bad request
          content:
            application/json:
              schema:
                type: object
                description: MessageContext
                properties:
                  origin:
                    type: string
                    examples:
                      - LOCAL
                  originVersion:
                    type: string
                    examples:
                      - 25R1Q-P-03-SNAPSHOT
                  originHost:
                    type: string
                    examples:
                      - edc9d5c538d7
                  requestId:
                    type: string
                    examples:
                      - 36388b6f-df09-4005-abda-4d0af277e44a
                  service:
                    type: string
                    examples:
                      - HUB_BLC
                  lastEventCode:
                    type: string
                    description: |
                      Here is the list of defined functional error codes and their meaning:
                      <details>
                        <summary>Click to expand</summary>
                        | Error code | Description |
                        | --- | --- |
                        | 400010005 | Bad parameter : service |
                        | 400050515 | RBA issuer config update request cannot be null. |
                        | 400050517 | RBA issuer config id cannot be null. |
                        | 400050518 | RBA issuer config interface type cannot be null. |
                        | 400050519 | RBA issuer config service cannot be null or empty. |
                        | 400050520 | RBA issuer config issuer cannot be null or empty when sub issuer provided. |
                        | 400050521 | RBA issuer config default decision cannot be null. |
                        | 400050522 | RBA issuer config duplicate origin priority. |
                        | 400050525 | RBA scoring provider create or update request cannot be null. |
                        | 400050526 | RBA scoring provider id cannot be null. |
                        | 400050527 | RBA scoring provider score type cannot be null. |
                        | 400050528 | RBA scoring provider provider type cannot be null. |
                        | 400050529 | RBA scoring provider score service url cannot be null or empty. |
                        | 400050531 | RBA issuer config not found. |
                        | 400050532 | RBA issuer config already exists. |
                      </details>
                    examples:
                      - 400050002
                  privateAPI:
                    type: boolean
                    examples:
                      - false
        "403":
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                description: MessageContext
                properties:
                  origin:
                    type: string
                    examples:
                      - LOCAL
                  originVersion:
                    type: string
                    examples:
                      - 25R1Q-P-03-SNAPSHOT
                  originHost:
                    type: string
                    examples:
                      - edc9d5c538d7
                  requestId:
                    type: string
                    examples:
                      - 36388b6f-df09-4005-abda-4d0af277e44a
                  service:
                    type: string
                    examples:
                      - HUB_BLC
                  lastEventCode:
                    type: string
                    description: |
                      Here is the list of defined functional error codes and their meaning:
                      <details>
                        <summary>Click to expand</summary>
                        | Error code | Description |
                        | --- | --- |
                        | 403000000 | The provided Api-Key is invalid or expired. |
                      </details>
                    examples:
                      - 403000000
                  privateAPI:
                    type: boolean
                    examples:
                      - false
  /admin/issuerconfig/all/{service}:
    get:
      tags:
        - issuerConfig
      summary: Get all issuers configs.
      description: |
        Get all issuers configs.
      operationId: getAllIssuerConfigs
      parameters:
        - name: service
          in: path
          description: Service code
          required: true
          schema:
            type: string
            minLength: 1
            maxLength: 255
            pattern: '^[A-Z\d]{3}_[A-Z\d]{3}(?:_[A-Z\d]+)*$'
          example: HUB_NRT
      responses:
        "200":
          description: Default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IssuerConfigListResponse'
  /admin/issuerconfig/{service}:
    get:
      tags:
        - issuerConfig
      summary: Get a specific issuer configs.
      description: |
        Get a specific issuer configs.
      operationId: getIssuerConfig
      parameters:
        - name: service
          in: path
          description: Service code
          required: true
          schema:
            type: string
            minLength: 1
            maxLength: 255
            pattern: '^[A-Z\d]{3}_[A-Z\d]{3}(?:_[A-Z\d]+)*$'
          example: HUB_NRT
        - name: issuer
          in: query
          description: Issuer code
          schema:
            type: string
            length: 5
          example: 66666
        - name: subIssuer
          in: query
          description: Sub-issuer code
          schema:
            type: string
            length: 5
          example: 66666
      responses:
        "200":
          description: Default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IssuerConfigListResponse'
  /admin/issuerconfig/{service}/{id}:
    get:
      tags:
        - issuerConfig
      summary: Get a specific issuer config by ID.
      description: |
        Get a specific issuer config by ID.
      operationId: getIssuerConfigById
      parameters:
        - name: service
          in: path
          description: Service code
          required: true
          schema:
            type: string
            minLength: 1
            maxLength: 255
            pattern: '^[A-Z\d]{3}_[A-Z\d]{3}(?:_[A-Z\d]+)*$'
          example: HUB_NRT
        - name: id
          in: path
          description: ID
          required: true
          schema:
            type: integer
            format: int64
          example: 2
      responses:
        "200":
          description: Default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IssuerConfigResponse'
  # Operand API definition
  /admin/operand/label/{service}:
    put:
      tags:
        - operand
      summary: Update an operand label.
      description: |
        Update existing operand label in order to change its operand value.
      operationId: updateOperandLabel
      parameters:
        - name: id
          in: query
          description: ID
          required: true
          schema:
            type: integer
            format: int64
          example: 1
        - name: ruleSetID
          in: query
          description: Ruleset ID
          required: true
          schema:
            type: integer
            format: int64
          example: 2
        - name: label
          in: query
          description: Label
          required: true
          schema:
            type: string
          example: label
        - name: service
          in: path
          description: Service code
          required: true
          schema:
            type: string
            minLength: 1
            maxLength: 255
            pattern: '^[A-Z\d]{3}_[A-Z\d]{3}(?:_[A-Z\d]+)*$'
          example: HUB_NRT
      responses:
        "200":
          description: Default response
        "400":
          description: Bad request
          content:
            application/json:
              schema:
                type: object
                description: MessageContext
                properties:
                  origin:
                    type: string
                    examples:
                      - LOCAL
                  originVersion:
                    type: string
                    examples:
                      - 25R1Q-P-03-SNAPSHOT
                  originHost:
                    type: string
                    examples:
                      - edc9d5c538d7
                  requestId:
                    type: string
                    examples:
                      - 36388b6f-df09-4005-abda-4d0af277e44a
                  service:
                    type: string
                    examples:
                      - HUB_BLC
                  lastEventCode:
                    type: string
                    description: |
                      Here is the list of defined functional error codes and their meaning:
                      <details>
                        <summary>Click to expand</summary>
                        | Error code | Description |
                        | --- | --- |
                        | 400010005 | Bad parameter : service |
                        | 400090011 | Bad parameter : Undefined operand ID |
                        | 400090020 | Bad parameter : Undefined Rule Set ID |
                      </details>
                    examples:
                      - 400090020
                  privateAPI:
                    type: boolean
                    examples:
                      - false
        "403":
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                description: MessageContext
                properties:
                  origin:
                    type: string
                    examples:
                      - LOCAL
                  originVersion:
                    type: string
                    examples:
                      - 25R1Q-P-03-SNAPSHOT
                  originHost:
                    type: string
                    examples:
                      - edc9d5c538d7
                  requestId:
                    type: string
                    examples:
                      - 36388b6f-df09-4005-abda-4d0af277e44a
                  service:
                    type: string
                    examples:
                      - HUB_BLC
                  lastEventCode:
                    type: string
                    description: |
                      Here is the list of defined functional error codes and their meaning:
                      <details>
                        <summary>Click to expand</summary>
                        | Error code | Description |
                        | --- | --- |
                        | 403000000 |The provided Api-Key is invalid or expired. |
                      </details>
                    examples:
                      - 400050002
                  privateAPI:
                    type: boolean
                    examples:
                      - false
        "404":
          description: Not found
          content:
            application/json:
              schema:
                type: object
                description: MessageContext
                properties:
                  origin:
                    type: string
                    examples:
                      - LOCAL
                  originVersion:
                    type: string
                    examples:
                      - 25R1Q-P-03-SNAPSHOT
                  originHost:
                    type: string
                    examples:
                      - edc9d5c538d7
                  requestId:
                    type: string
                    examples:
                      - 36388b6f-df09-4005-abda-4d0af277e44a
                  service:
                    type: string
                    examples:
                      - HUB_BLC
                  lastEventCode:
                    type: string
                    description: |
                      Here is the list of defined functional error codes and their meaning:
                      <details>
                        <summary>Click to expand</summary>
                        | Error code | Description |
                        | --- | --- |
                        | 404060000 | Rule operand not found |
                        | 404060007 | Rule operand value not found |
                      </details>
                    examples:
                      - 400050002
                  privateAPI:
                    type: boolean
                    examples:
                      - false
  /admin/operand/value/{service}:
    put:
      tags:
        - operand
      summary: Update operand value operation.
      description: |
        Update existing operand value by operand value label and ruleset
        ID.
      operationId: updateOperandValue
      parameters:
        - name: ruleSetID
          in: query
          description: Ruleset ID
          required: true
          schema:
            type: integer
            format: int64
          example: 1
        - name: label
          in: query
          description: Label
          required: true
          schema:
            type: string
          example: label
        - name: value
          in: query
          description: Value
          required: true
          schema:
            type: integer
            format: int64
          example: value
        - name: service
          in: path
          description: Service code
          required: true
          schema:
            type: string
            minLength: 1
            maxLength: 255
            pattern: '^[A-Z\d]{3}_[A-Z\d]{3}(?:_[A-Z\d]+)*$'
          example: HUB_NRT
      responses:
        "200":
          description: Default response
        "400":
          description: Bad request
          content:
            application/json:
              schema:
                type: object
                description: MessageContext
                properties:
                  origin:
                    type: string
                    examples:
                      - LOCAL
                  originVersion:
                    type: string
                    examples:
                      - 25R1Q-P-03-SNAPSHOT
                  originHost:
                    type: string
                    examples:
                      - edc9d5c538d7
                  requestId:
                    type: string
                    examples:
                      - 36388b6f-df09-4005-abda-4d0af277e44a
                  service:
                    type: string
                    examples:
                      - HUB_BLC
                  lastEventCode:
                    type: string
                    description: |
                      Here is the list of defined functional error codes and their meaning:
                      <details>
                        <summary>Click to expand</summary>
                        | Error code | Description |
                        | --- | --- |
                        | 400010005 | Bad parameter : service |
                        | 400090015 | Bad parameter : Undefined operand Value |
                        | 400090020 | Bad parameter : Undefined Rule Set ID |
                      </details>
                    examples:
                      - 400010005
                  privateAPI:
                    type: boolean
                    examples:
                      - false
        "403":
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                description: MessageContext
                properties:
                  origin:
                    type: string
                    examples:
                      - LOCAL
                  originVersion:
                    type: string
                    examples:
                      - 25R1Q-P-03-SNAPSHOT
                  originHost:
                    type: string
                    examples:
                      - edc9d5c538d7
                  requestId:
                    type: string
                    examples:
                      - 36388b6f-df09-4005-abda-4d0af277e44a
                  service:
                    type: string
                    examples:
                      - HUB_BLC
                  lastEventCode:
                    type: string
                    description: |
                      Here is the list of defined functional error codes and their meaning:
                      <details>
                        <summary>Click to expand</summary>
                        | Error code | Description |
                        | --- | --- |
                        | 403000000 | The provided Api-Key is invalid or expired. |
                      </details>
                    examples:
                      - 403000000
                  privateAPI:
                    type: boolean
                    examples:
                      - false
        "404":
          description: Not found
          content:
            application/json:
              schema:
                type: object
                description: MessageContext
                properties:
                  origin:
                    type: string
                    examples:
                      - LOCAL
                  originVersion:
                    type: string
                    examples:
                      - 25R1Q-P-03-SNAPSHOT
                  originHost:
                    type: string
                    examples:
                      - edc9d5c538d7
                  requestId:
                    type: string
                    examples:
                      - 36388b6f-df09-4005-abda-4d0af277e44a
                  service:
                    type: string
                    examples:
                      - HUB_BLC
                  lastEventCode:
                    type: string
                    description: |
                      Here is the list of defined functional error codes and their meaning:
                      <details>
                        <summary>Click to expand</summary>
                        | Error code | Description |
                        | --- | --- |
                        | 404060007 | Rule operand value not found |
                      </details>
                    examples:
                      - 400090020
                  privateAPI:
                    type: boolean
                    examples:
                      - false
        "520":
          description: Unexpected error
          content:
            application/json:
              schema:
                type: object
                description: MessageContext
                properties:
                  origin:
                    type: string
                    examples:
                      - LOCAL
                  originVersion:
                    type: string
                    examples:
                      - 25R1Q-P-03-SNAPSHOT
                  originHost:
                    type: string
                    examples:
                      - edc9d5c538d7
                  requestId:
                    type: string
                    examples:
                      - 36388b6f-df09-4005-abda-4d0af277e44a
                  service:
                    type: string
                    examples:
                      - HUB_BLC
                  lastEventCode:
                    type: string
                    description: |
                      Here is the list of defined functional error codes and their meaning:
                      <details>
                        <summary>Click to expand</summary>
                        | Error code | Description |
                        | --- | --- |
                        | 520000000 | Unexpected error |
                      </details>
                    examples:
                      - 520000000
                  privateAPI:
                    type: boolean
                    examples:
                      - false
  /admin/operand/values/{service}:
    put:
      tags:
        - operand
      summary: Update operand values operation.
      description: |
        Update existing operand values by operand values list and ruleset
        ID.
      operationId: updateOperandValues
      parameters:
        - name: service
          in: path
          description: Service code
          required: true
          schema:
            type: string
            minLength: 1
            maxLength: 255
            pattern: '^[A-Z\d]{3}_[A-Z\d]{3}(?:_[A-Z\d]+)*$'
          example: HUB_NRT
        - name: ruleSetID
          in: query
          description: Ruleset ID
          required: true
          schema:
            type: integer
            format: int64
          example: 2
      requestBody:
        description: The list of ruleset operand value DTO
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/OperandValueDTO'
        required: true
      responses:
        "200":
          description: Default response
        "400":
          description: Bad request
          content:
            application/json:
              schema:
                type: object
                description: MessageContext
                properties:
                  origin:
                    type: string
                    examples:
                      - LOCAL
                  originVersion:
                    type: string
                    examples:
                      - 25R1Q-P-03-SNAPSHOT
                  originHost:
                    type: string
                    examples:
                      - edc9d5c538d7
                  requestId:
                    type: string
                    examples:
                      - 36388b6f-df09-4005-abda-4d0af277e44a
                  service:
                    type: string
                    examples:
                      - HUB_BLC
                  lastEventCode:
                    type: string
                    description: |
                      Here is the list of defined functional error codes and their meaning:
                      <details>
                        <summary>Click to expand</summary>
                        | Error code | Description |
                        | --- | --- |
                        | 400010005 | Bad parameter : service |
                        | 400090010 | Bad parameter : Undefined operand |
                        | 400090020 | Bad parameter : Undefined Rule Set ID |
                        | 400090025 | Bad parameter : Invalid operand value |
                        | 400090026 | Bad parameter : Invalid operand label |
                      </details>
                    examples:
                      - 400010005
                  privateAPI:
                    type: boolean
                    examples:
                      - false
        "403":
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                description: MessageContext
                properties:
                  origin:
                    type: string
                    examples:
                      - LOCAL
                  originVersion:
                    type: string
                    examples:
                      - 25R1Q-P-03-SNAPSHOT
                  originHost:
                    type: string
                    examples:
                      - edc9d5c538d7
                  requestId:
                    type: string
                    examples:
                      - 36388b6f-df09-4005-abda-4d0af277e44a
                  service:
                    type: string
                    examples:
                      - HUB_BLC
                  lastEventCode:
                    type: string
                    description: |
                      Here is the list of defined functional error codes and their meaning:
                      <details>
                        <summary>Click to expand</summary>
                        | Error code | Description |
                        | --- | --- |
                        | 403000000 | The provided Api-Key is invalid or expired. |
                      </details>
                    examples:
                      - 403000000
                  privateAPI:
                    type: boolean
                    examples:
                      - false
        "404":
          description: Not found
          content:
            application/json:
              schema:
                type: object
                description: MessageContext
                properties:
                  origin:
                    type: string
                    examples:
                      - LOCAL
                  originVersion:
                    type: string
                    examples:
                      - 25R1Q-P-03-SNAPSHOT
                  originHost:
                    type: string
                    examples:
                      - edc9d5c538d7
                  requestId:
                    type: string
                    examples:
                      - 36388b6f-df09-4005-abda-4d0af277e44a
                  service:
                    type: string
                    examples:
                      - HUB_BLC
                  lastEventCode:
                    type: string
                    description: |
                      Here is the list of defined functional error codes and their meaning:
                      <details>
                        <summary>Click to expand</summary>
                        | Error code | Description |
                        | --- | --- |
                        | 404060007 | Rule operand value not found|
                      </details>
                    examples:
                      - 404060007
                  privateAPI:
                    type: boolean
                    examples:
                      - false
        "520":
          description: Unexpected error
          content:
            application/json:
              schema:
                type: object
                description: MessageContext
                properties:
                  origin:
                    type: string
                    examples:
                      - LOCAL
                  originVersion:
                    type: string
                    examples:
                      - 25R1Q-P-03-SNAPSHOT
                  originHost:
                    type: string
                    examples:
                      - edc9d5c538d7
                  requestId:
                    type: string
                    examples:
                      - 36388b6f-df09-4005-abda-4d0af277e44a
                  service:
                    type: string
                    examples:
                      - HUB_BLC
                  lastEventCode:
                    type: string
                    description: |
                      Here is the list of defined functional error codes and their meaning:
                      <details>
                        <summary>Click to expand</summary>
                        | Error code | Description |
                        | --- | --- |
                        | 520000000 | Unexpected error |
                      </details>
                    examples:
                      - 520000000
                  privateAPI:
                    type: boolean
                    examples:
                      - false
  /admin/operand/{service}/{ruleSetId}:
    get:
      tags:
        - operand
      summary: Get rule set operand values
      description: |
        Get rule set operand values by rule set id and service, if nothing
         found empty map will be returned
      operationId: getRuleSetOperandValues
      parameters:
        - name: ruleSetId
          in: path
          description: Ruleset id
          required: true
          schema:
            type: integer
            format: int64
          example: 1
        - name: service
          in: path
          description: Service code
          required: true
          schema:
            type: string
            minLength: 1
            maxLength: 255
            pattern: '^[A-Z\d]{3}_[A-Z\d]{3}(?:_[A-Z\d]+)*$'
          example: HUB_NRT
      responses:
        "200":
          description: Default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListOperandValueDTO'
        "400":
          description: Bad request
          content:
            application/json:
              schema:
                type: object
                description: MessageContext
                properties:
                  origin:
                    type: string
                    examples:
                      - LOCAL
                  originVersion:
                    type: string
                    examples:
                      - 25R1Q-P-03-SNAPSHOT
                  originHost:
                    type: string
                    examples:
                      - edc9d5c538d7
                  requestId:
                    type: string
                    examples:
                      - 36388b6f-df09-4005-abda-4d0af277e44a
                  service:
                    type: string
                    examples:
                      - HUB_BLC
                  lastEventCode:
                    type: string
                    description: |
                      Here is the list of defined functional error codes and their meaning:
                      <details>
                        <summary>Click to expand</summary>
                        | Error code | Description |
                        | --- | --- |
                        | 400010005 | Bad parameter : service |
                        | 400090020 | Bad parameter : Undefined Rule Set ID |
                      </details>
                    examples:
                      - 400010005
                  privateAPI:
                    type: boolean
                    examples:
                      - false
        "403":
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                description: MessageContext
                properties:
                  origin:
                    type: string
                    examples:
                      - LOCAL
                  originVersion:
                    type: string
                    examples:
                      - 25R1Q-P-03-SNAPSHOT
                  originHost:
                    type: string
                    examples:
                      - edc9d5c538d7
                  requestId:
                    type: string
                    examples:
                      - 36388b6f-df09-4005-abda-4d0af277e44a
                  service:
                    type: string
                    examples:
                      - HUB_BLC
                  lastEventCode:
                    type: string
                    description: |
                      Here is the list of defined functional error codes and their meaning:
                      <details>
                        <summary>Click to expand</summary>
                        | Error code | Description |
                        | --- | --- |
                        | 403000000 | The provided Api-Key is invalid or expired. |
                      </details>
                    examples:
                      - 403000000
                  privateAPI:
                    type: boolean
                    examples:
                      - false
  # RuleSet API definition
  /admin/presetrules/{service}:
    get:
      tags:
        - rule
      summary: "Ruleset details, rules, conditions, operands"
      description: |
        ruleset details, rules, conditions, operands.
      operationId: getPresetRuleSetDetails
      parameters:
        - name: service
          in: path
          description: Service code
          required: true
          schema:
            type: string
            minLength: 1
            maxLength: 255
            pattern: '^[A-Z\d]{3}_[A-Z\d]{3}(?:_[A-Z\d]+)*$'
          example: HUB_NRT
      responses:
        "200":
          description: Default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RuleSetListResponse'
  /admin/rule/activation/{service}:
    put:
      tags:
        - rule
      summary: Update rule to make it active or inactive.
      description: |
        Update rule activation flag. ID, Service and Flag are mandatory.
      operationId: updateRuleActivation
      parameters:
        - name: id
          in: query
          description: ID
          required: true
          schema:
            type: integer
            format: int64
          example: 1
        - name: activate
          in: query
          description: Flag
          required: true
          schema:
            type: boolean
          example: true
        - name: service
          in: path
          description: Service code
          required: true
          schema:
            type: string
            minLength: 1
            maxLength: 255
            pattern: '^[A-Z\d]{3}_[A-Z\d]{3}(?:_[A-Z\d]+)*$'
          example: HUB_NRT
      responses:
        "200":
          description: Default response
        "400":
          description: Bad request
          content:
            application/json:
              schema:
                type: object
                description: MessageContext
                properties:
                  origin:
                    type: string
                    examples:
                      - LOCAL
                  originVersion:
                    type: string
                    examples:
                      - 25R1Q-P-03-SNAPSHOT
                  originHost:
                    type: string
                    examples:
                      - edc9d5c538d7
                  requestId:
                    type: string
                    examples:
                      - 36388b6f-df09-4005-abda-4d0af277e44a
                  service:
                    type: string
                    examples:
                      - HUB_BLC
                  lastEventCode:
                    type: string
                    description: |
                      Here is the list of defined functional error codes and their meaning:
                      <details>
                        <summary>Click to expand</summary>         
                        | Error code | Description |
                        | --- | --- |
                        | 400010005 | Bad parameter : service |
                        | 400090031 | Bad parameter : Undefined rule ID |
                        | 400090042 | Bad parameter : Undefined activation flag |
                        | 400090043 | Bad parameter : Activation flag should not be applied on default rule |
                      </details>
                    examples:
                      - 400010005
                  privateAPI:
                    type: boolean
                    examples:
                      - false
        "403":
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                description: MessageContext
                properties:
                  origin:
                    type: string
                    examples:
                      - LOCAL
                  originVersion:
                    type: string
                    examples:
                      - 25R1Q-P-03-SNAPSHOT
                  originHost:
                    type: string
                    examples:
                      - edc9d5c538d7
                  requestId:
                    type: string
                    examples:
                      - 36388b6f-df09-4005-abda-4d0af277e44a
                  service:
                    type: string
                    examples:
                      - HUB_BLC
                  lastEventCode:
                    type: string
                    description: |
                      Here is the list of defined functional error codes and their meaning:
                      <details>
                        <summary>Click to expand</summary>
                        | Error code | Description |
                        | --- | --- |
                        | 403000000 | The provided Api-Key is invalid or expired. |
                      </details>
                    examples:
                      - 403000000
                  privateAPI:
                    type: boolean
                    examples:
                      - false
        "404":
          description: Not found
          content:
            application/json:
              schema:
                type: object
                description: MessageContext
                properties:
                  origin:
                    type: string
                    examples:
                      - LOCAL
                  originVersion:
                    type: string
                    examples:
                      - 25R1Q-P-03-SNAPSHOT
                  originHost:
                    type: string
                    examples:
                      - edc9d5c538d7
                  requestId:
                    type: string
                    examples:
                      - 36388b6f-df09-4005-abda-4d0af277e44a
                  service:
                    type: string
                    examples:
                      - HUB_BLC
                  lastEventCode:
                    type: string
                    description: |
                      Here is the list of defined functional error codes and their meaning:
                      <details>
                        <summary>Click to expand</summary>
                      - `404060002`: Rule not found
                        | Error code | Description |
                        | --- | --- |
                        | 404060002 | Rule not found |
                      </details>
                    examples:
                      - 404060002
                  privateAPI:
                    type: boolean
                    examples:
                      - false
  /admin/rule/authtype/{service}:
    put:
      tags:
        - rule
      summary: Update rule authentication type operation.
      description: |
        Update rule authentication type operation by rule identifier.
      operationId: updateRuleAuthType
      parameters:
        - name: id
          in: query
          description: ID
          required: true
          schema:
            type: integer
            format: int64
          example: 2
        - name: value
          in: query
          description: value
          required: true
          schema:
            type: string
          example: FRICTIONLESS
        - name: reason
          in: query
          description: reason
          required: true
          schema:
            type: string
          example: LOW_SCORE
        - name: service
          in: path
          description: Service code
          required: true
          schema:
            type: string
            minLength: 1
            maxLength: 255
            pattern: '^[A-Z\d]{3}_[A-Z\d]{3}(?:_[A-Z\d]+)*$'
          example: HUB_NRT
      responses:
        "200":
          description: Default response
        "400":
          description: Bad request
          content:
            application/json:
              schema:
                type: object
                description: MessageContext
                properties:
                  origin:
                    type: string
                    examples:
                      - LOCAL
                  originVersion:
                    type: string
                    examples:
                      - 25R1Q-P-03-SNAPSHOT
                  originHost:
                    type: string
                    examples:
                      - edc9d5c538d7
                  requestId:
                    type: string
                    examples:
                      - 36388b6f-df09-4005-abda-4d0af277e44a
                  service:
                    type: string
                    examples:
                      - HUB_BLC
                  lastEventCode:
                    type: string
                    description: |
                      Here is the list of defined functional error codes and their meaning:
                      <details>
                        <summary>Click to expand</summary>
                        | Error code | Description |
                        | --- | --- |
                        | 400010005 | Bad parameter : service |
                        | 400090031 | Bad parameter : Undefined rule ID |
                        | 400090033 | Bad parameter : Undefined rule auth type |
                      </details>
                    examples:
                      - 400010005
                  privateAPI:
                    type: boolean
                    examples:
                      - false
        "403":
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                description: MessageContext
                properties:
                  origin:
                    type: string
                    examples:
                      - LOCAL
                  originVersion:
                    type: string
                    examples:
                      - 25R1Q-P-03-SNAPSHOT
                  originHost:
                    type: string
                    examples:
                      - edc9d5c538d7
                  requestId:
                    type: string
                    examples:
                      - 36388b6f-df09-4005-abda-4d0af277e44a
                  service:
                    type: string
                    examples:
                      - HUB_BLC
                  lastEventCode:
                    type: string
                    description: |
                      Here is the list of defined functional error codes and their meaning:
                      <details>
                        <summary>Click to expand</summary>  
                        | Error code | Description |
                        | --- | --- |
                        | 403000000 | The provided Api-Key is invalid or expired. |
                      </details>
                    examples:
                      - 403000000
                  privateAPI:
                    type: boolean
                    examples:
                      - false
        "404":
          description: Not found
          content:
            application/json:
              schema:
                type: object
                description: MessageContext
                properties:
                  origin:
                    type: string
                    examples:
                      - LOCAL
                  originVersion:
                    type: string
                    examples:
                      - 25R1Q-P-03-SNAPSHOT
                  originHost:
                    type: string
                    examples:
                      - edc9d5c538d7
                  requestId:
                    type: string
                    examples:
                      - 36388b6f-df09-4005-abda-4d0af277e44a
                  service:
                    type: string
                    examples:
                      - HUB_BLC
                  lastEventCode:
                    type: string
                    description: |
                      Here is the list of defined functional error codes and their meaning:
                      <details>
                        <summary>Click to expand</summary>  
                        | Error code | Description |
                        | --- | --- |
                        | 404060002 | Rule not found |
                      </details>
                    examples:
                      - 404060002
                  privateAPI:
                    type: boolean
                    examples:
                      - false
  /admin/rule/ordinals/{service}:
    put:
      tags:
        - rule
      summary: Move up/down rule by updating ordinals.
      description: |
        If the ordinal is the first one then up is impossible, if the
         ordinal is the last one then down is impossible.
      operationId: updateRuleOrdinal
      parameters:
        - name: service
          in: path
          description: Service code
          required: true
          schema:
            type: string
            minLength: 1
            maxLength: 255
            pattern: '^[A-Z\d]{3}_[A-Z\d]{3}(?:_[A-Z\d]+)*$'
          example: HUB_NRT
      requestBody:
        description: UpdateRuleOrdinalRequest
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateRuleOrdinalRequest'
        required: true
      responses:
        "200":
          description: Default response
        "400":
          description: Bad request
          content:
            application/json:
              schema:
                type: object
                description: MessageContext
                properties:
                  origin:
                    type: string
                    examples:
                      - LOCAL
                  originVersion:
                    type: string
                    examples:
                      - 25R1Q-P-03-SNAPSHOT
                  originHost:
                    type: string
                    examples:
                      - edc9d5c538d7
                  requestId:
                    type: string
                    examples:
                      - 36388b6f-df09-4005-abda-4d0af277e44a
                  service:
                    type: string
                    examples:
                      - HUB_BLC
                  lastEventCode:
                    type: string
                    description: |
                      Here is the list of defined functional error codes and their meaning:
                      <details>
                        <summary>Click to expand</summary>
                        | Error code | Description |
                        | --- | --- |
                        | 400010005 | Bad parameter : service |
                        | 400100000 | Bad request : Invalid incoming request |
                        | 400090031 | Bad parameter : Undefined rule ID |
                        | 400090044 | Bad parameter : First rule ordinal is not decremental |
                        | 400090045 | Bad parameter : First rule ordinal is not incremental |
                        | 400090046 | Bad parameter : Undefined rule ordinal update type |
                      </details>
                    examples:
                      - 400010005
                  privateAPI:
                    type: boolean
                    examples:
                      - false
        "403":
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                description: MessageContext
                properties:
                  origin:
                    type: string
                    examples:
                      - LOCAL
                  originVersion:
                    type: string
                    examples:
                      - 25R1Q-P-03-SNAPSHOT
                  originHost:
                    type: string
                    examples:
                      - edc9d5c538d7
                  requestId:
                    type: string
                    examples:
                      - 36388b6f-df09-4005-abda-4d0af277e44a
                  service:
                    type: string
                    examples:
                      - HUB_BLC
                  lastEventCode:
                    type: string
                    description: |
                      Here is the list of defined functional error codes and their meaning:
                      <details>
                        <summary>Click to expand</summary> 
                        | Error code | Description |
                        | --- | --- |
                        | 403000000 | The provided Api-Key is invalid or expired. |
                      </details>
                    examples:
                      - 403000000
                  privateAPI:
                    type: boolean
                    examples:
                      - false
        "404":
          description: Not found
          content:
            application/json:
              schema:
                type: object
                description: MessageContext
                properties:
                  origin:
                    type: string
                    examples:
                      - LOCAL
                  originVersion:
                    type: string
                    examples:
                      - 25R1Q-P-03-SNAPSHOT
                  originHost:
                    type: string
                    examples:
                      - edc9d5c538d7
                  requestId:
                    type: string
                    examples:
                      - 36388b6f-df09-4005-abda-4d0af277e44a
                  service:
                    type: string
                    examples:
                      - HUB_BLC
                  lastEventCode:
                    type: string
                    description: |
                      Here is the list of defined functional error codes and their meaning:
                      <details>
                        <summary>Click to expand</summary>
                        | Error code | Description |
                        | --- | --- |
                        | 404060002 | Rule not found |
                      </details>
                    examples:
                      - 404060002
                  privateAPI:
                    type: boolean
                    examples:
                      - false
  /admin/rule/reorder/{service}:
    put:
      tags:
        - rule
      summary: Reorder all rules by updating ordinals.
      description: |
        If rulesetId exist, all rules exists and are linked to the provided
         rulesetId, all rules of rulesetId are included in the list, then reorder
         is possible.
      operationId: reorderRules
      parameters:
        - name: service
          in: path
          description: Service code
          required: true
          schema:
            type: string
            minLength: 1
            maxLength: 255
            pattern: '^[A-Z\d]{3}_[A-Z\d]{3}(?:_[A-Z\d]+)*$'
          example: HUB_NRT
        - name: userID
          in: query
          description: User ID
          required: true
          schema:
            type: string
          example: 12
      requestBody:
        description: UpdateAllRulesOrdinalsRequest
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateAllRulesOrdinalsRequest'
        required: true
      responses:
        "200":
          description: Default response
        "400":
          description: Bad request
          content:
            application/json:
              schema:
                type: object
                description: MessageContext
                properties:
                  origin:
                    type: string
                    examples:
                      - LOCAL
                  originVersion:
                    type: string
                    examples:
                      - 25R1Q-P-03-SNAPSHOT
                  originHost:
                    type: string
                    examples:
                      - edc9d5c538d7
                  requestId:
                    type: string
                    examples:
                      - 36388b6f-df09-4005-abda-4d0af277e44a
                  service:
                    type: string
                    examples:
                      - HUB_BLC
                  lastEventCode:
                    type: string
                    description: |
                      Here is the list of defined functional error codes and their meaning:
                      <details>
                        <summary>Click to expand</summary>
                        | Error code | Description |
                        | --- | --- |
                        | 400010005 | Bad parameter : service |
                        | 400100000 | Bad request : Invalid incoming request |
                        | 400090048 | Bad parameter : Update the ordinals should not be applied on mismatched rules |
                        | 400090047 | Bad parameter : Update should not be applied on default rule |
                      </details>
                    examples:
                      - 400010005
                  privateAPI:
                    type: boolean
                    examples:
                      - false
        "403":
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                description: MessageContext
                properties:
                  origin:
                    type: string
                    examples:
                      - LOCAL
                  originVersion:
                    type: string
                    examples:
                      - 25R1Q-P-03-SNAPSHOT
                  originHost:
                    type: string
                    examples:
                      - edc9d5c538d7
                  requestId:
                    type: string
                    examples:
                      - 36388b6f-df09-4005-abda-4d0af277e44a
                  service:
                    type: string
                    examples:
                      - HUB_BLC
                  lastEventCode:
                    type: string
                    description: |
                      Here is the list of defined functional error codes and their meaning:
                      <details>
                        <summary>Click to expand</summary>
                        | Error code | Description |
                        | --- | --- |
                        | 403000000 | The provided Api-Key is invalid or expired. |
                      </details>
                    examples:
                      - 403000000
                  privateAPI:
                    type: boolean
                    examples:
                      - false
        "412":
          description: Precondition failed
          content:
            application/json:
              schema:
                type: object
                description: MessageContext
                properties:
                  origin:
                    type: string
                    examples:
                      - LOCAL
                  originVersion:
                    type: string
                    examples:
                      - 25R1Q-P-03-SNAPSHOT
                  originHost:
                    type: string
                    examples:
                      - edc9d5c538d7
                  requestId:
                    type: string
                    examples:
                      - 36388b6f-df09-4005-abda-4d0af277e44a
                  service:
                    type: string
                    examples:
                      - HUB_BLC
                  lastEventCode:
                    type: string
                    description: |
                      Here is the list of defined functional error codes and their meaning:
                      <details>
                        <summary>Click to expand</summary>
                      - `412010000`: Rule set precondition failed
                        | Error code | Description |
                        | --- | --- |
                        | 412010000 | Rule set precondition failed |
                      </details>
                    examples:
                      - 412010000
                  privateAPI:
                    type: boolean
                    examples:
                      - false
  /admin/rule/{service}:
    put:
      tags:
        - rule
      summary: Update rule params.
      description: |
        Update rule params by rule.
      operationId: createOrUpdateRule
      parameters:
        - name: service
          in: path
          description: Service code
          required: true
          schema:
            type: string
            minLength: 1
            maxLength: 255
            pattern: '^[A-Z\d]{3}_[A-Z\d]{3}(?:_[A-Z\d]+)*$'
          example: HUB_NRT
        - name: userID
          in: query
          description: User ID
          required: true
          schema:
            type: string
          example: 5
      requestBody:
        description: Rule
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RuleDTO'
        required: true
      responses:
        "200":
          description: Default response
        "400":
          description: Bad request
          content:
            application/json:
              schema:
                type: object
                description: MessageContext
                properties:
                  origin:
                    type: string
                    examples:
                      - LOCAL
                  originVersion:
                    type: string
                    examples:
                      - 25R1Q-P-03-SNAPSHOT
                  originHost:
                    type: string
                    examples:
                      - edc9d5c538d7
                  requestId:
                    type: string
                    examples:
                      - 36388b6f-df09-4005-abda-4d0af277e44a
                  service:
                    type: string
                    examples:
                      - HUB_BLC
                  lastEventCode:
                    type: string
                    description: |
                      Here is the list of defined functional error codes and their meaning:
                      <details>
                        <summary>Click to expand</summary>
                        | Error code | Description |
                        | --- | --- |
                        | 400010005 | Bad parameter : service |
                        | 400090030 | Bad parameter : Undefined rule |
                        | 400090031 | Bad parameter : Undefined rule ID |
                        | 400090047 | Bad parameter : Update should not be applied on default rule |
                      </details>
                    examples:
                      - 400010005
                  privateAPI:
                    type: boolean
                    examples:
                      - false
        "403":
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                description: MessageContext
                properties:
                  origin:
                    type: string
                    examples:
                      - LOCAL
                  originVersion:
                    type: string
                    examples:
                      - 25R1Q-P-03-SNAPSHOT
                  originHost:
                    type: string
                    examples:
                      - edc9d5c538d7
                  requestId:
                    type: string
                    examples:
                      - 36388b6f-df09-4005-abda-4d0af277e44a
                  service:
                    type: string
                    examples:
                      - HUB_BLC
                  lastEventCode:
                    type: string
                    description: |
                      Here is the list of defined functional error codes and their meaning:
                      <details>
                        <summary>Click to expand</summary>
                        | Error code | Description |
                        | --- | --- |
                        | 403000000 | The provided Api-Key is invalid or expired. |
                      </details>
                    examples:
                      - 403000000
                  privateAPI:
                    type: boolean
                    examples:
                      - false
        "404":
          description: Not found
          content:
            application/json:
              schema:
                type: object
                description: MessageContext
                properties:
                  origin:
                    type: string
                    examples:
                      - LOCAL
                  originVersion:
                    type: string
                    examples:
                      - 25R1Q-P-03-SNAPSHOT
                  originHost:
                    type: string
                    examples:
                      - edc9d5c538d7
                  requestId:
                    type: string
                    examples:
                      - 36388b6f-df09-4005-abda-4d0af277e44a
                  service:
                    type: string
                    examples:
                      - HUB_BLC
                  lastEventCode:
                    type: string
                    description: |
                      Here is the list of defined functional error codes and their meaning:
                      <details>
                        <summary>Click to expand</summary>
                        | Error code | Description |
                        | --- | --- |
                        | 404060006 | Default rule is missing |
                        | 404060002 | Rule not found |
                      </details>
                    examples:
                      - 404060006
                  privateAPI:
                    type: boolean
                    examples:
                      - false
        "412":
          description: Precondition failed
          content:
            application/json:
              schema:
                type: object
                description: MessageContext
                properties:
                  origin:
                    type: string
                    examples:
                      - LOCAL
                  originVersion:
                    type: string
                    examples:
                      - 25R1Q-P-03-SNAPSHOT
                  originHost:
                    type: string
                    examples:
                      - edc9d5c538d7
                  requestId:
                    type: string
                    examples:
                      - 36388b6f-df09-4005-abda-4d0af277e44a
                  service:
                    type: string
                    examples:
                      - HUB_BLC
                  lastEventCode:
                    type: string
                    description: |
                      Here is the list of defined functional error codes and their meaning:
                      <details>
                        <summary>Click to expand</summary>
                        | Error code | Description |
                        | --- | --- |
                        | 412010000 | Rule set precondition failed |
                      </details>
                    examples:
                      - 412010000
                  privateAPI:
                    type: boolean
                    examples:
                      - false
    delete:
      tags:
        - rule
      summary: Delete rule.
      description: |
        If rule exists and linked to the rule set with status DRAFT_EDIT,
         rule will be deleted.
      operationId: deleteRule
      parameters:
        - name: service
          in: path
          description: Service code
          required: true
          schema:
            type: string
            minLength: 1
            maxLength: 255
            pattern: '^[A-Z\d]{3}_[A-Z\d]{3}(?:_[A-Z\d]+)*$'
          example: HUB_NRT
        - name: ruleSetId
          in: query
          description: Ruleset ID
          required: true
          schema:
            type: integer
            format: int64
          example: 2
        - name: ruleId
          in: query
          description: RuleId
          schema:
            type: integer
            format: int64
          example: 1
      responses:
        "200":
          description: Default response
        "400":
          description: Bad request
          content:
            application/json:
              schema:
                type: object
                description: MessageContext
                properties:
                  origin:
                    type: string
                    examples:
                      - LOCAL
                  originVersion:
                    type: string
                    examples:
                      - 25R1Q-P-03-SNAPSHOT
                  originHost:
                    type: string
                    examples:
                      - edc9d5c538d7
                  requestId:
                    type: string
                    examples:
                      - 36388b6f-df09-4005-abda-4d0af277e44a
                  service:
                    type: string
                    examples:
                      - HUB_BLC
                  lastEventCode:
                    type: string
                    description: |
                      Here is the list of defined functional error codes and their meaning:
                      <details>
                        <summary>Click to expand</summary>
                        | Error code | Description |
                        | --- | --- |
                        | 400010005 | Bad parameter : service |
                        | 400090020 | Bad parameter : Undefined Rule Set ID |
                        | 400090027 | Bad parameter : Undefined Rule Set |
                        | 400090030 | Bad parameter : Undefined rule |
                        | 400090031 | Bad parameter : Undefined rule ID |
                        | 400090050 | Bad parameter : Invalid rule set status |
                      </details>
                    examples:
                      - 400010005
                  privateAPI:
                    type: boolean
                    examples:
                      - false
        "403":
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                description: MessageContext
                properties:
                  origin:
                    type: string
                    examples:
                      - LOCAL
                  originVersion:
                    type: string
                    examples:
                      - 25R1Q-P-03-SNAPSHOT
                  originHost:
                    type: string
                    examples:
                      - edc9d5c538d7
                  requestId:
                    type: string
                    examples:
                      - 36388b6f-df09-4005-abda-4d0af277e44a
                  service:
                    type: string
                    examples:
                      - HUB_BLC
                  lastEventCode:
                    type: string
                    description: |
                      Here is the list of defined functional error codes and their meaning:
                      <details>
                        <summary>Click to expand</summary>
                      - `403000000`: The provided Api-Key is invalid or expired.
                        | Error code | Description |
                        | --- | --- |
                        | 403000000 | The provided Api-Key is invalid or expired. |
                      </details>
                    examples:
                      - 403000000
                  privateAPI:
                    type: boolean
                    examples:
                      - false
        "412":
          description: Precondition failed
          content:
            application/json:
              schema:
                type: object
                description: MessageContext
                properties:
                  origin:
                    type: string
                    examples:
                      - LOCAL
                  originVersion:
                    type: string
                    examples:
                      - 25R1Q-P-03-SNAPSHOT
                  originHost:
                    type: string
                    examples:
                      - edc9d5c538d7
                  requestId:
                    type: string
                    examples:
                      - 36388b6f-df09-4005-abda-4d0af277e44a
                  service:
                    type: string
                    examples:
                      - HUB_BLC
                  lastEventCode:
                    type: string
                    description: |
                      Here is the list of defined functional error codes and their meaning:
                      <details>
                        <summary>Click to expand</summary>
                        | Error code | Description |
                        | --- | --- |
                        | 412010000 | Rule set precondition failed |
                      </details>
                    examples:
                      - 412010000
                  privateAPI:
                    type: boolean
                    examples:
                      - false
  /admin/ruleset:
    put:
      tags:
        - ruleset
      summary: Update Ruleset by dto.
      description: |
        Update Ruleset by dto.
      operationId: updateRuleSet
      parameters:
        - name: userID
          in: query
          description: User ID
          required: true
          schema:
            type: string
          example: 1
      requestBody:
        description: Ruleset
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RuleSetDTO'
        required: true
      responses:
        "200":
          description: Default response
        "400":
          description: Bad request
          content:
            application/json:
              schema:
                type: object
                description: MessageContext
                properties:
                  origin:
                    type: string
                    examples:
                      - LOCAL
                  originVersion:
                    type: string
                    examples:
                      - 25R1Q-P-03-SNAPSHOT
                  originHost:
                    type: string
                    examples:
                      - edc9d5c538d7
                  requestId:
                    type: string
                    examples:
                      - 36388b6f-df09-4005-abda-4d0af277e44a
                  service:
                    type: string
                    examples:
                      - HUB_BLC
                  lastEventCode:
                    type: string
                    description: |
                      Here is the list of defined functional error codes and their meaning:
                      <details>
                        <summary>Click to expand</summary>
                        | Error code | Description |
                        | --- | --- |
                        | 400010005 | Bad parameter : service |
                        | 400090010 | Bad parameter : Undefined operand |
                        | 400090012 | Bad parameter : Undefined operand Name |
                        | 400090013 | Bad parameter : Undefined operand Type |
                        | 400090014 | Bad parameter : Operand Type and Name Mismatched |
                        | 400090015 | Bad parameter : Undefined operand Value |
                        | 400090016 | Bad parameter : Undefined condition |
                        | 400090018 | Bad parameter : Undefined condition Name |
                        | 400090020 | Bad parameter : Undefined Rule Set ID |
                        | 400090021 | Bad parameter : Undefined Rule Set Service |
                        | 400090023 | Bad parameter : No rules defined |
                        | 400090024 | Bad parameter : Invalid value for the action code operand |
                        | 400090027 | Bad parameter : Undefined Rule Set |
                        | 400090028 | Bad parameter : Invalid device channel |
                        | 400090030 | Bad parameter : Undefined rule |
                        | 400090032 | Bad parameter : Undefined rule name |
                        | 400090040 | Bad parameter : Undefined rule reason type |
                        | 400090041 | Bad parameter : Rule reason type is mismatched with auth type |
                      </details>
                    examples:
                      - 400010005
                  privateAPI:
                    type: boolean
                    examples:
                      - false
        "403":
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                description: MessageContext
                properties:
                  origin:
                    type: string
                    examples:
                      - LOCAL
                  originVersion:
                    type: string
                    examples:
                      - 25R1Q-P-03-SNAPSHOT
                  originHost:
                    type: string
                    examples:
                      - edc9d5c538d7
                  requestId:
                    type: string
                    examples:
                      - 36388b6f-df09-4005-abda-4d0af277e44a
                  service:
                    type: string
                    examples:
                      - HUB_BLC
                  lastEventCode:
                    type: string
                    description: |
                      Here is the list of defined functional error codes and their meaning:
                      <details>
                        <summary>Click to expand</summary>
                        | Error code | Description |
                        | --- | --- |
                        | 403000000 | The provided Api-Key is invalid or expired. |
                      </details>
                    examples:
                      - 403000000
                  privateAPI:
                    type: boolean
                    examples:
                      - false
        "404":
          description: Not found
          content:
            application/json:
              schema:
                type: object
                description: MessageContext
                properties:
                  origin:
                    type: string
                    examples:
                      - LOCAL
                  originVersion:
                    type: string
                    examples:
                      - 25R1Q-P-03-SNAPSHOT
                  originHost:
                    type: string
                    examples:
                      - edc9d5c538d7
                  requestId:
                    type: string
                    examples:
                      - 36388b6f-df09-4005-abda-4d0af277e44a
                  service:
                    type: string
                    examples:
                      - HUB_BLC
                  lastEventCode:
                    type: string
                    description: |
                      Here is the list of defined functional error codes and their meaning:
                      <details>
                        <summary>Click to expand</summary>
                        | Error code | Description |
                        | --- | --- |
                        | 404060010 | Ruleset has no active rule |
                        | 404060003 | No rule found in default group |
                        | 404060005 | Rule should have at least one condition |
                        | 404060014 | Ruleset version not found. |
                        | 404060015 | Ruleset groupid not found. |
                        | 404060016 | Ruleset status not found. |
                        | 404060006 | Default rule is missing |
                      </details>
                    examples:
                      - 404060006
                  privateAPI:
                    type: boolean
                    examples:
                      - false
        "412":
          description: Precondition failed
          content:
            application/json:
              schema:
                type: object
                description: MessageContext
                properties:
                  origin:
                    type: string
                    examples:
                      - LOCAL
                  originVersion:
                    type: string
                    examples:
                      - 25R1Q-P-03-SNAPSHOT
                  originHost:
                    type: string
                    examples:
                      - edc9d5c538d7
                  requestId:
                    type: string
                    examples:
                      - 36388b6f-df09-4005-abda-4d0af277e44a
                  service:
                    type: string
                    examples:
                      - HUB_BLC
                  lastEventCode:
                    type: string
                    description: |
                      Here is the list of defined functional error codes and their meaning:
                      <details>
                        <summary>Click to expand</summary>
                        | Error code | Description |
                        | --- | --- |
                        | 412010000 | Rule set precondition failed |
                      </details>
                    examples:
                      - 412010000
                  privateAPI:
                    type: boolean
                    examples:
                      - false
  /admin/ruleset/clone/{service}:
    post:
      tags:
        - ruleset
      summary: Clone a rule set by ID.
      description: |
        Will return the clone of the rule set passed by parameter.
      operationId: cloneRuleSetById
      parameters:
        - name: id
          in: query
          description: ID
          required: true
          schema:
            type: integer
            format: int64
          example: 1
        - name: service
          in: path
          description: Service code
          required: true
          schema:
            type: string
            minLength: 1
            maxLength: 255
            pattern: '^[A-Z\d]{3}_[A-Z\d]{3}(?:_[A-Z\d]+)*$'
          example: HUB_NRT
        - name: userID
          in: query
          description: User ID
          schema:
            type: string
          example: 1
        - name: comment
          in: query
          description: Comment
          schema:
            type: string
      responses:
        "200":
          description: Default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RuleSetDetailsResponse'
  /admin/ruleset/export/{service}/{id}:
    get:
      tags:
        - ruleset
      summary: Export ruleSet json file by ID.
      description: |
        Export ruleSet json file by ID.
      operationId: exportRuleSet
      parameters:
        - name: service
          in: path
          description: Service code
          required: true
          schema:
            type: string
            minLength: 1
            maxLength: 255
            pattern: '^[A-Z\d]{3}_[A-Z\d]{3}(?:_[A-Z\d]+)*$'
          example: HUB_NRT
        - name: id
          in: path
          description: ID
          required: true
          schema:
            type: integer
            format: int64
          example: 1
      responses:
        "200":
          description: Default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RuleSetExportDataResponse'
  /admin/ruleset/import/{service}/{id}:
    post:
      tags:
        - ruleset
      summary: Import ruleSet from json file.
      description: |
        Import ruleSet from json file.
      operationId: importRuleSet
      parameters:
        - name: id
          in: path
          description: ruleset ID
          required: true
          schema:
            type: integer
            format: int64
          example: 1
        - name: service
          in: path
          description: Service code
          required: true
          schema:
            type: string
            minLength: 1
            maxLength: 255
            pattern: '^[A-Z\d]{3}_[A-Z\d]{3}(?:_[A-Z\d]+)*$'
          example: HUB_NRT
        - name: userID
          in: query
          description: User ID
          schema:
            type: string
        - name: comment
          in: query
          description: Comment
          schema:
            type: string
      requestBody:
        description: RulesetExportData
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RulesetExportDataRequest'
        required: true
      responses:
        "200":
          description: Default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RuleSetDetailsResponse'
  /admin/ruleset/list:
    get:
      tags:
        - ruleset
      summary: "List of RuleSet by service, issuer and sub-issuer."
      description: |
        Retrieve all ranges information at platform level, for a specific
         issuer or for a specific sub issuer of an issuer.
      operationId: getRuleSetList
      parameters:
        - name: service
          in: query
          description: Service code
          required: true
          schema:
            type: string
            minLength: 1
            maxLength: 255
            pattern: '^[A-Z\d]{3}_[A-Z\d]{3}(?:_[A-Z\d]+)*$'
          example: HUB_NRT
        - name: bcf
          in: query
          description: Issuer
          required: true
          schema:
            type: string
            length: 5
          example: 66666
        - name: bdom
          in: query
          description: SubIssuer
          required: true
          schema:
            type: string
            length: 5
          example: 66666
        - name: excludeRules
          in: query
          description: ExcludeRules
          required: true
          schema:
            type: boolean
          example: false
      responses:
        "200":
          description: Default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RuleSetListResponse'
  /admin/ruleset/state:
    post:
      tags:
        - ruleset
      summary: Change the status of a rule set
      description: |
        Will change the status of the rule set passed by parameter
      operationId: changeRuleSetState
      requestBody:
        description: RuleSetStateRequestDTO
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RuleSetStateRequestDTO'
        required: true
      responses:
        "200":
          description: Default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RuleSetDetailsResponse'
  /admin/ruleset/{service}:
    get:
      tags:
        - ruleset
      summary: "Ruleset details, rules, conditions, operands"
      description: |
        Ruleset details, rules, conditions, operands. ID is mandatory.
      operationId: getRuleSetDetails_1
      parameters:
        - name: id
          in: query
          description: ID
          required: true
          schema:
            type: integer
            format: int64
          example: 1
        - name: service
          in: path
          description: Service code
          required: true
          schema:
            type: string
            minLength: 1
            maxLength: 255
            pattern: '^[A-Z\d]{3}_[A-Z\d]{3}(?:_[A-Z\d]+)*$'
          example: HUB_NRT
      responses:
        "200":
          description: Default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RuleSetDetailsResponse'
  /admin/ruleset/{service}/{groupId}:
    get:
      tags:
        - ruleset
      summary: "Ruleset details, rules, conditions, operands"
      description: |
        Ruleset details, rules, conditions, operands.
      operationId: getRuleSetDetails
      parameters:
        - name: service
          in: path
          description: Service code
          required: true
          schema:
            type: string
            minLength: 1
            maxLength: 255
            pattern: '^[A-Z\d]{3}_[A-Z\d]{3}(?:_[A-Z\d]+)*$'
          example: HUB_NRT
        - name: groupId
          in: path
          description: GroupId
          required: true
          schema:
            type: string
          example: 3dbc5e0e-463f-11ed-a4f2-0242ac190003
        - name: state
          in: query
          description: State
          schema:
            type: string
          example: PROD
      responses:
        "200":
          description: Default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RuleSetDetailsResponse'
  # ScoreConfig API definition
  /admin/scoreconfig:
    put:
      tags:
        - scoreConfig
      summary: Update a score config.
      description: |
        Update a score config.
      operationId: updateScoreConfig
      requestBody:
        description: The updated score config item to persist
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ScoreConfigDTO'
        required: true
      responses:
        "200":
          description: Default response
        "400":
          description: Bad request
          content:
            application/json:
              schema:
                type: object
                description: MessageContext
                properties:
                  origin:
                    type: string
                    examples:
                      - LOCAL
                  originVersion:
                    type: string
                    examples:
                      - 25R1Q-P-03-SNAPSHOT
                  originHost:
                    type: string
                    examples:
                      - edc9d5c538d7
                  requestId:
                    type: string
                    examples:
                      - 36388b6f-df09-4005-abda-4d0af277e44a
                  service:
                    type: string
                    examples:
                      - HUB_BLC
                  lastEventCode:
                    type: string
                    description: |
                      Here is the list of defined functional error codes and their meaning:
                      <details>
                        <summary>Click to expand</summary>
                        | Error code | Description |
                        | --- | --- |
                        | 400010005 | Bad parameter : service |
                        | 400050500 | RBA score config cannot be null. |
                        | 400050501 | RBA score config id cannot be null or empty. |
                        | 400050502 | RBA score config service cannot be null or empty. |
                        | 400050503 | RBA score config issuer cannot be null or empty when sub issuer provided. |
                        | 400050506 | RBA score config interface type cannot be null. |
                        | 400050507 | RBA score config provider type cannot be null. |
                        | 400050504 | RBA score config score service url cannot be null or empty. |
                        | 400050505 | RBA score config advice service url cannot be null or empty. |
                        | 400050510 | RBA score config default decision cannot be null. |
                        | 400050514 | RBA score config duplicate origin priority. |
                      </details>
                    examples:
                      - 400050002
                  privateAPI:
                    type: boolean
                    examples:
                      - false
        "403":
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                description: MessageContext
                properties:
                  origin:
                    type: string
                    examples:
                      - LOCAL
                  originVersion:
                    type: string
                    examples:
                      - 25R1Q-P-03-SNAPSHOT
                  originHost:
                    type: string
                    examples:
                      - edc9d5c538d7
                  requestId:
                    type: string
                    examples:
                      - 36388b6f-df09-4005-abda-4d0af277e44a
                  service:
                    type: string
                    examples:
                      - HUB_BLC
                  lastEventCode:
                    type: string
                    description: |
                      Here is the list of defined functional error codes and their meaning:
                      <details>
                        <summary>Click to expand</summary>
                        | Error code | Description |
                        | --- | --- |
                        | 403000000 | The provided Api-Key is invalid or expired. |
                      </details>
                    examples:
                      - 403000000
                  privateAPI:
                    type: boolean
                    examples:
                      - false
  /admin/scoreconfig/all/{service}:
    get:
      tags:
        - scoreConfig
      summary: Get all score config elements.
      description: |
        Get all score config elements.
      operationId: getAllScoreConfigs
      parameters:
        - name: service
          in: path
          description: Service code
          required: true
          schema:
            type: string
            minLength: 1
            maxLength: 255
            pattern: '^[A-Z\d]{3}_[A-Z\d]{3}(?:_[A-Z\d]+)*$'
          example: HUB_NRT
      responses:
        "200":
          description: Default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScoreConfigListResponse'
  /admin/scoreconfig/{service}:
    get:
      tags:
        - scoreConfig
      summary: Get a list of score configs.
      description: |
        Get a list of score configs.
      operationId: getScoreConfig
      parameters:
        - name: service
          in: path
          description: Service code
          required: true
          schema:
            type: string
            minLength: 1
            maxLength: 255
            pattern: '^[A-Z\d]{3}_[A-Z\d]{3}(?:_[A-Z\d]+)*$'
          example: HUB_NRT
        - name: issuer
          in: query
          description: Issuer Code
          schema:
            type: string
            length: 5
          example: 66666
        - name: subIssuer
          in: query
          description: SubIssuer Code
          schema:
            type: string
            length: 5
          example: 66666
      responses:
        "200":
          description: Default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScoreConfigListResponse'
  /admin/scoreconfig/{service}/{id}:
    get:
      tags:
        - scoreConfig
      summary: Get a score configs by ID.
      description: |
        Get a score configs by ID.
      operationId: getScoreConfigById
      parameters:
        - name: service
          in: path
          description: Service code
          required: true
          schema:
            type: string
            minLength: 1
            maxLength: 255
            pattern: '^[A-Z\d]{3}_[A-Z\d]{3}(?:_[A-Z\d]+)*$'
          example: HUB_NRT
        - name: id
          in: path
          description: ID
          required: true
          schema:
            type: integer
            format: int64
          example: 5
      responses:
        "200":
          description: Default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScoreConfigResponse'
  # Whitelist Trusted beneficiary API definition
  /admin/whitelist:
    post:
      tags:
        - whitelist
      summary: Create trusted beneficiary element.
      description: |
        Create trusted beneficiary element. All required parameters are
        validated.
      operationId: createTrustedBeneficiary
      requestBody:
        description: TrustedBeneficiary object to create
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TrustedBeneficiaryDTO'
        required: true
      responses:
        "200":
          description: Default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RbaAdminResponseOneTB'
    delete:
      tags:
        - whitelist
      summary: Delete trusted beneficiary element.
      description: |
        Delete trusted beneficiary element.
      operationId: deleteTrustedBeneficiary
      requestBody:
        description: The trusted beneficiary item to delete
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TrustedBeneficiaryDTO'
        required: true
      responses:
        "200":
          description: Default response
        "400":
          description: Bad request
          content:
            application/json:
              schema:
                type: object
                description: MessageContext
                properties:
                  origin:
                    type: string
                    examples:
                      - LOCAL
                  originVersion:
                    type: string
                    examples:
                      - 25R1Q-P-03-SNAPSHOT
                  originHost:
                    type: string
                    examples:
                      - edc9d5c538d7
                  requestId:
                    type: string
                    examples:
                      - 36388b6f-df09-4005-abda-4d0af277e44a
                  service:
                    type: string
                    examples:
                      - HUB_BLC
                  lastEventCode:
                    type: string
                    description: |
                      Here is the list of defined functional error codes and their meaning:
                      <details>
                        <summary>Click to expand</summary>
                        | Error code | Description |
                        | --- | --- |
                        | 400010005 | Bad parameter : service |
                      </details>
                    examples:
                      - 400010005
                  privateAPI:
                    type: boolean
                    examples:
                      - false
        "403":
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                description: MessageContext
                properties:
                  origin:
                    type: string
                    examples:
                      - LOCAL
                  originVersion:
                    type: string
                    examples:
                      - 25R1Q-P-03-SNAPSHOT
                  originHost:
                    type: string
                    examples:
                      - edc9d5c538d7
                  requestId:
                    type: string
                    examples:
                      - 36388b6f-df09-4005-abda-4d0af277e44a
                  service:
                    type: string
                    examples:
                      - HUB_BLC
                  lastEventCode:
                    type: string
                    description: |
                      Here is the list of defined functional error codes and their meaning:
                      <details>
                        <summary>Click to expand</summary>
                        | Error code | Description |
                        | --- | --- |
                        | 403000000 | The provided Api-Key is invalid or expired. |
                      </details>
                    examples:
                      - 403000000
                  privateAPI:
                    type: boolean
                    examples:
                      - false
        "404":
          description: Not found
          content:
            application/json:
              schema:
                type: object
                description: MessageContext
                properties:
                  origin:
                    type: string
                    examples:
                      - LOCAL
                  originVersion:
                    type: string
                    examples:
                      - 25R1Q-P-03-SNAPSHOT
                  originHost:
                    type: string
                    examples:
                      - edc9d5c538d7
                  requestId:
                    type: string
                    examples:
                      - 36388b6f-df09-4005-abda-4d0af277e44a
                  service:
                    type: string
                    examples:
                      - HUB_BLC
                  lastEventCode:
                    type: string
                    description: |
                      Here is the list of defined functional error codes and their meaning:
                      <details>
                        <summary>Click to expand</summary>
                        | Error code | Description |
                        | --- | --- |
                        | 404060008 | Trusted beneficiary element not found |
                      </details>
                    examples:
                      - 404060008
                  privateAPI:
                    type: boolean
                    examples:
                      - false
        "520":
          description: Unexpected error
          content:
            application/json:
              schema:
                type: object
                description: MessageContext
                properties:
                  origin:
                    type: string
                    examples:
                      - LOCAL
                  originVersion:
                    type: string
                    examples:
                      - 25R1Q-P-03-SNAPSHOT
                  originHost:
                    type: string
                    examples:
                      - edc9d5c538d7
                  requestId:
                    type: string
                    examples:
                      - 36388b6f-df09-4005-abda-4d0af277e44a
                  service:
                    type: string
                    examples:
                      - HUB_BLC
                  lastEventCode:
                    type: string
                    description: |
                      Here is the list of defined functional error codes and their meaning:
                      <details>
                        <summary>Click to expand</summary>
                        | Error code | Description |
                        | --- | --- |
                        | 520000000 | Unexpected error |
                      </details>
                    examples:
                      - 520000000
                  privateAPI:
                    type: boolean
                    examples:
                      - false
  /admin/whitelist/search:
    post:
      tags:
        - whitelist
      summary: Search trusted beneficiary elements by TrustedBeneficiaryInternalRequest.
      description: |
        Search trusted beneficiary elements by service, trusted beneficiary
        type, payer, payer type, payee, payee type, issuer and sub-issuer.
      operationId: searchTrustedBeneficiaries_2
      requestBody:
        description: TrustedBeneficiaryInternalRequest
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TrustedBeneficiaryInternalRequest'
        required: true
      responses:
        "200":
          description: Default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RbaAdminResponseListTB'
  /admin/whitelist/search-by-payer:
    post:
      tags:
        - whitelist
      summary: Search trusted beneficiary elements by TrustedBeneficiaryExternalRequest.
      description: |
        Search trusted beneficiary elements by service, issuer, sub-issuer,
         trusted beneficiary type, payer, payer type, and payee if it is provided
         (payee filtering using like operation with all payee types)
      operationId: searchTrustedBeneficiaries_1
      requestBody:
        description: TrustedBeneficiaryExternalRequest
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TrustedBeneficiaryExternalRequest'
        required: true
      responses:
        "200":
          description: Default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RbaAdminExternalResponseListTB'
  /admin/whitelist/{service}:
    get:
      tags:
        - whitelist
      summary: Get all trusted beneficiaries.
      description: |
        Get all trusted beneficiaries.
      operationId: getAllTrustedBeneficiaries
      parameters:
        - name: service
          in: path
          description: Service code
          required: true
          schema:
            type: string
            minLength: 1
            maxLength: 255
            pattern: '^[A-Z\d]{3}_[A-Z\d]{3}(?:_[A-Z\d]+)*$'
          example: HUB_NRT
      responses:
        "200":
          description: Default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RbaAdminResponseListTB'
  /admin/whitelist/{service}/page/{page}:
    get:
      tags:
        - whitelist
      summary: Get all trusted beneficiaries.
      description: |
        Get all trusted beneficiaries.
      operationId: getAllTrustedBeneficiariesPage
      parameters:
        - name: service
          in: path
          description: Service code
          required: true
          schema:
            type: string
            minLength: 1
            maxLength: 255
            pattern: '^[A-Z\d]{3}_[A-Z\d]{3}(?:_[A-Z\d]+)*$'
          example: HUB_NRT
        - name: page
          in: path
          description: Page
          required: true
          schema:
            type: integer
            format: int32
          example: 1
      responses:
        "200":
          description: Default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RbaAdminResponseListTB'
  /admin/whitelist/{service}/{types}:
    get:
      tags:
        - whitelist
      summary: "Search trusted beneficiary elements by service, type and value or\
        \ label."
      description: |
        Search trusted beneficiary elements by type and value or label.
         It's possible to filter by issuer or sub-issuer.
      operationId: searchTrustedBeneficiaries
      parameters:
        - name: service
          in: path
          description: Service code
          required: true
          schema:
            type: string
            minLength: 1
            maxLength: 255
            pattern: '^[A-Z\d]{3}_[A-Z\d]{3}(?:_[A-Z\d]+)*$'
          example: HUB_NRT
        - name: types
          in: path
          description: "TrustedBeneficiary types: TRUST_LIST_ACS ..."
          required: true
          schema:
            type: string
            examples:
              - TRUST_LIST_DS
        - name: searchBy
          in: query
          description: "Where to search the value. payee,payer,payeeType,payerType"
          required: true
          schema:
            type: string
          example: payee
        - name: value
          in: query
          description: Value to search either among labels or values
          required: true
          schema:
            type: string
          example: payeeValue
        - name: bcf
          in: query
          description: Issuer code
          schema:
            type: string
            length: 5
          example: 66666
        - name: bdom
          in: query
          description: Sub-issuer code
          schema:
            type: string
            length: 5
          example: 66666
      responses:
        "200":
          description: Default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RbaAdminResponseListTB'
  /admin/whitelist/{service}/{types}/count:
    get:
      tags:
        - whitelist
      summary: "Count trusted beneficiary elements by service, type and value or label."
      description: |
        count trusted beneficiary elements by type and value or label.
        It's possible to filter by issuer or sub-issuer.
      operationId: countTrustedBeneficiaries
      parameters:
        - name: service
          in: path
          description: Service code
          required: true
          schema:
            type: string
            minLength: 1
            maxLength: 255
            pattern: '^[A-Z\d]{3}_[A-Z\d]{3}(?:_[A-Z\d]+)*$'
          example: HUB_NRT
        - name: types
          in: path
          description: "TrustedBeneficiary types: TRUST_LIST_ACS ..."
          required: true
          schema:
            type: string
            examples:
              - TRUST_LIST_ACS
        - name: searchBy
          in: query
          description: "Where to search the value. payee,payer,payeeType,payerType"
          required: true
          schema:
            type: string
          example: payee
        - name: value
          in: query
          description: Value to search either among labels or values
          required: true
          schema:
            type: string
          example: payeeValue
        - name: bcf
          in: query
          description: Issuer code
          schema:
            type: string
            length: 5
          example: 66666
        - name: bdom
          in: query
          description: Sub-issuer code
          schema:
            type: string
            length: 5
          example: 66666
      responses:
        "200":
          description: Default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RbaAdminResponseCount'
  /admin/whitelist/{service}/{types}/page/{page}:
    get:
      tags:
        - whitelist
      summary: "Search trusted beneficiary elements by service, type and value or\
        \ label."
      description: |
        Search trusted beneficiary elements by type and value or label.
        It's possible to filter by issuer or sub-issuer.
      operationId: searchTrustedBeneficiariesPage
      parameters:
        - name: service
          in: path
          description: Service code
          required: true
          schema:
            type: string
            minLength: 1
            maxLength: 255
            pattern: '^[A-Z\d]{3}_[A-Z\d]{3}(?:_[A-Z\d]+)*$'
          example: HUB_NRT
        - name: types
          in: path
          description: "TrustedBeneficiary types: TRUST_LIST_ACS ..."
          required: true
          schema:
            type: string
            examples:
              - TRUST_LIST_ACS
        - name: page
          in: path
          description: Page number
          required: true
          schema:
            type: integer
            format: int32
          example: 1
        - name: searchBy
          in: query
          description: "Where to search the value. payee,payer,payeeType,payerType"
          required: true
          schema:
            type: string
          example: payee
        - name: value
          in: query
          description: Value to search either among labels or values
          required: true
          schema:
            type: string
          example: payeeValue
        - name: bcf
          in: query
          description: Issuer code
          schema:
            type: string
            length: 5
          example: 66666
        - name: bdom
          in: query
          description: Sub-issuer code
          schema:
            type: string
            length: 5
          example: 66666
      responses:
        "200":
          description: Default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RbaAdminResponseListTB'
# Components
components:
  schemas:
    AuthTypeDTO:
      type: object
      properties:
        name:
          type: string
          description: AuthType dto name
          examples:
            - FRICTIONLESS
        reasons:
          type: array
          items:
            type: string
            enum:
              - LOW_VALUE
              - LOW_SCORE
              - RECURRING
              - ACQ_EXEMPTION
              - SEC_CORPORATE
              - INSTALMENT
              - THREE_RI_INSTALMENT
              - THREE_RI_CARDINFO
              - THREE_RI_WHITELIST
              - THREE_RI_RECURRING
              - THREE_RI_MOTO
              - FRICTIONLESS_DECISION
              - FRICTIONLESS_MERCHANT_TOP_LEVEL
              - ACQ_EXEMPTION_TRA
              - ACQ_EXEMPTION_DATA_SHARE_ONLY
              - ACQ_EXEMPTION_SCA_ALREADY_DONE
              - FRICTIONLESS_TRUSTED_BENEF_ACS
              - FRICTIONLESS_TRUSTED_BENEF_3DSSERVER
              - FRICTIONLESS_TRUSTED_BENEF_DS
              - THREE_RI_ADD_CARD
              - THREE_RI_PAYMENT
              - THREE_RI_SPLIT_TRN
              - SCA_SPLIT_DELAYED_TRN
              - THREE_RI_ACCOUNT
              - DAF_MUST_APPROVE
              - DAF_ISSUER_DECISION_LOW_RISK
              - FRICTIONLESS_MAINTENANCE_MODE
              - DAF_FIDO_ASSERTION_OK
              - DAF_FIDO_ATTESTATION_OK
              - DAF_FIDO_ATTESTATION_KO
              - DAF_FIDO_ASSERTION_OBO_OK
              - DAF_FIDO_ATTESTATION_OBO_INFO
              - DAF_FIDO_ASSERTION_OBO_VTS_INFO
              - DAF_FIDO_ASSERTION_VTS_OK
              - DAF_FIDO_ASSERTION_VTS_KO
              - HIGH_VALUE
              - HIGH_SCORE
              - MID_VALUE
              - MID_SCORE
              - MAX_FRICTIONLESS
              - NO_RULES
              - RBA_FALLBACK
              - FIRST_RECURRING
              - FIRST_SCA
              - ACQ_SCA_REQ
              - THREE_RI_DECOUPLED
              - FIRST_INSTALMENT
              - SCA_DECISION
              - SCA_MERCHANT_TOP_LEVEL
              - ID_V_SCA_REQ
              - SCA_TRUSTED_BENEF_3DSSERVER
              - SCA_TRUSTED_BENEF_DS
              - SCA_TRUSTED_BENEF_ACS
              - THREE_RI_SCA_ADD_CARD
              - DAF_ENROLMENT
              - DAF_FIDO_ENROLLMENT_AUTHORIZED
              - DAF_FIDO_ENROLLMENT_REFUSED
              - HIGH_RISK
              - MEDIUM_RISK
              - SCA_ADD_CARD
              - RISK_FRAUD
              - BIN_ATTACK_FRAUD
              - BLACKLISTED
              - DECLINE_DECISION
              - DECLINE_MERCHANT_TOP_LEVEL
              - THREE_RI_DECLINE_ADD_CARD
              - THREE_RI_NOT_SUPPORTED
              - DAF_ISSUER_DECISION_HIGH_RISK
              - DAF_NOT_SUPPORTED
              - DAF_NON_VDAP
              - DAF_SUSPECTED_FRAUD
              - DECLINE_MAINTENANCE_MODE
              - DAF_STOLEN_CARD
              - PRIOR_TRN_NOT_FOUND
              - INVALID_CARD_NUMBER
              - STOLEN_CARD
              - TRN_NOT_PERMITTED
              - DAF_FIDO_ASSERTION_KO
              - DAF_FIDO_ASSERTION_OBO_KO
              - EXT_RBA
              - LOW_RISK_MERCHANT_CB
              - MC_CARD_TESTING_ATTACK
              - UNKNOWN
      description: AuthType DTO resource representation
    AuthTypeListResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            authMeans:
              type: array
              items:
                type: string
            authentId:
              type: string
            blackListStatus:
              type: array
              items:
                type: string
            cardHolderId:
              type: string
            comment:
              type: string
            errorCode:
              type: string
              description: |
                Here is the list of defined functional error codes and their meaning:
                <details>
                  <summary>Click to expand</summary>

                  | Error code | Description |
                  | --- | --- |
                  | 403000000 | The provided Api-Key is invalid or expired | 
                  | 400010005 | Bad parameter |
                </details>
              examples:
                - 403000000
            extRbaDecision:
              type: string
            extRbaLevel:
              type: integer
              format: int32
            externalWSResponse:
              type: string
            id:
              type: string
            issuerCode:
              type: string
            issuerRbaDecision:
              type: string
            issuerRbaLevel:
              type: integer
              format: int32
            language:
              type: string
            message:
              type: string
              examples:
                - The provided Api-Key is invalid or expired
            principal:
              $ref: '#/components/schemas/ErrorPrincipal'
            rbaDecision:
              type: string
            rbaLevel:
              type: string
            rbaReasonType:
              type: string
            site:
              type: string
            subIssuerCode:
              type: string
            tokenPan:
              type: string
            urlSite:
              type: string
        success:
          type: array
          description: List of AuthTypeDTO
          items:
            $ref: '#/components/schemas/AuthTypeDTO'
      description: List of AuthType DTO resource representation
    # Schemas define the structure of request BlackListDTO
    BlacklistDTO:
      required:
        - service
        - type
        - value
      type: object
      properties:
        bcf:
          type: string
          description: Blacklist dto bcf (not used)
          deprecated: true
        bdom:
          type: string
          description: Blacklist dto bdom (not used)
          deprecated: true
        createdTime:
          type: string
          description: Blacklist dto createdTime (not used)
          format: date-time
          deprecated: true
        deletedTime:
          type: string
          description: Blacklist dto deletedTime (not used)
          format: date-time
          deprecated: true
        id:
          type: integer
          description: Blacklist dto identifier, null (must not be provided, will be computed)
          format: int64
          deprecated: true
        keyboarded:
          type: string
          description: Blacklist dto keyboarded value (not used)
          deprecated: true
        label:
          type: string
          description: Blacklist dto label (not used)
          deprecated: true
        location:
          type: string
          description: Blacklist dto location
          examples:
            - ALL
        pivotAmount:
          type: integer
          description: Blacklist dto pivotAmount
          format: int64
          examples:
            - 0
        pivotAmountOperator:
          type: string
          description: Blacklist dto pivotAmountOperator
          enum:
            - GREATER_THAN
            - LESS_THAN
            - EQUAL_TO
            - LESS_THAN_OR_EQUAL
            - GREATER_THAN_OR_EQUAL
            - DIFF
          examples:
            - LESS_THAN
        service:
          $ref: '#/components/schemas/ServiceDTO'
        type:
          type: string
          description: Blacklist dto type
          enum:
            - IP
            - IPV6
            - IP_RANGE
            - IPV6_RANGE
            - EMAIL
            - PHONE
            - CARD_BLACK
            - CARD_WHITE
            - CARD_EXEMPTION
            - MERCHANT_URL
            - MERCHANT_COUNTRY
            - MERCHANT_ID
            - MERCHANT_NAME
            - MERCHANT_DOMAIN
            - RCPT_COUNTRY
          examples:
            - CARD_BLACK
        updatedTime:
          type: string
          description: Blacklist dto updatedTime (not used)
          format: date-time
          deprecated: true
        value:
          type: string
          description: Blacklist dto value
          examples:
            - "1.2.3.4"
      description: Blacklist DTO resource representation
    # Schemas define the structure of response BlackListDTO
    BlacklistResponseDTO:
      type: object
      properties:
        bcf:
          type: string
          description: Blacklist dto bcf
          deprecated: true
        bdom:
          type: string
          description: Blacklist dto bdom
          deprecated: true
        createdTime:
          type: string
          description: Blacklist dto createdTime
          format: date-time
          examples:
            - 2024-09-25T18:53:52.674+0400
        deletedTime:
          type: string
          description: Blacklist dto deletedTime
          format: date-time
          examples:
            - 2024-09-25T18:53:52.674+0400
        id:
          type: integer
          description: Blacklist dto identifier
          format: int64
          examples:
            - 12304
        keyboarded:
          type: string
          description: Blacklist dto keyboarded value
          deprecated: true
        label:
          type: string
          description: Blacklist dto label
          deprecated: true
        location:
          type: string
          description: Blacklist dto location
          examples:
            - ALL
        pivotAmount:
          type: integer
          description: Blacklist dto pivotAmount
          format: int64
          examples:
            - 0
        pivotAmountOperator:
          type: string
          description: Blacklist dto pivotAmountOperator
          enum:
            - GREATER_THAN
            - LESS_THAN
            - EQUAL_TO
            - LESS_THAN_OR_EQUAL
            - GREATER_THAN_OR_EQUAL
            - DIFF
          examples:
            - LESS_THAN
        service:
          $ref: '#/components/schemas/ServiceResponseDTO'
        type:
          type: string
          description: Blacklist dto type
          enum:
            - IP
            - IPV6
            - IP_RANGE
            - IPV6_RANGE
            - EMAIL
            - PHONE
            - CARD_BLACK
            - CARD_WHITE
            - CARD_EXEMPTION
            - MERCHANT_URL
            - MERCHANT_COUNTRY
            - MERCHANT_ID
            - MERCHANT_NAME
            - MERCHANT_DOMAIN
            - RCPT_COUNTRY
          examples:
            - CARD_BLACK
        updatedTime:
          type: string
          description: Blacklist dto updatedTime
          format: date-time
          examples:
            - 2024-09-25T18:53:52.674+0400
        value:
          type: string
          description: Blacklist dto value
          examples:
            - "1.2.3.4"
      description: Blacklist DTO resource representation
    RbaAdminResponseOneBL:
      type: object
      properties:
        error:
          type: object
          properties:
            authMeans:
              type: array
              items:
                type: string
            authentId:
              type: string
            blackListStatus:
              type: array
              items:
                type: string
            cardHolderId:
              type: string
            comment:
              type: string
            errorCode:
              type: string
              description: |
                Here is the list of defined functional error codes and their meaning:
                <details>
                  <summary>Click to expand</summary>
                  | Error code | Description |
                  | --- | --- |
                  | 403000000 | The provided Api-Key is invalid or expired | 
                  | 400010005 | Bad parameter |
                  | 400050001 | Blacklist duplication: Blacklist Item already exists |
                  | 400050002 | Bad parameter : Blacklist Type |
                  | 400050003 | Bad parameter : Blacklist Value |
                  | 400050004 | Bad parameter : Incoherent IP Range |
                  | 403010002 | Blacklist conflict : Whitelist Item already exists |
                  | 403010003 | Whitelist conflict : Blacklist Item already exists |
                </details>
              examples:
                - 403000000
            extRbaDecision:
              type: string
            extRbaLevel:
              type: integer
              format: int32
            externalWSResponse:
              type: string
            id:
              type: string
            issuerCode:
              type: string
            issuerRbaDecision:
              type: string
            issuerRbaLevel:
              type: integer
              format: int32
            language:
              type: string
            message:
              type: string
              examples:
                - The provided Api-Key is invalid or expired
            principal:
              $ref: '#/components/schemas/ErrorPrincipal'
            rbaDecision:
              type: string
            rbaLevel:
              type: string
            rbaReasonType:
              type: string
            site:
              type: string
            subIssuerCode:
              type: string
            tokenPan:
              type: string
            urlSite:
              type: string
        success:
          $ref: '#/components/schemas/BlacklistResponseDTO'
    RbaAdminResponseCount:
      type: object
      properties:
        error:
          type: object
          properties:
            authMeans:
              type: array
              items:
                type: string
            authentId:
              type: string
            blackListStatus:
              type: array
              items:
                type: string
            cardHolderId:
              type: string
            comment:
              type: string
            errorCode:
              type: string
              description: |
                Here is the list of defined functional error codes and their meaning:
                <details>
                  <summary>Click to expand</summary>
                  | Error code | Description |
                  | --- | --- |
                  | 403000000 | The provided Api-Key is invalid or expired | 
                  | 400010005 | Bad parameter : service |
                  | 400050002 | Bad parameter : Blacklist Type |
                  | 400090081 | Bad parameter : Invalid Trusted beneficiary request |
                  | 400090073 | Bad parameter : Undefined trusted beneficiary type |
                  | 400050005 | Bad parameter : Service Code |
                  | 520000000 | Unexpected error |
                </details>
              examples:
                - 403000000
            extRbaDecision:
              type: string
            extRbaLevel:
              type: integer
              format: int32
            externalWSResponse:
              type: string
            id:
              type: string
            issuerCode:
              type: string
            issuerRbaDecision:
              type: string
            issuerRbaLevel:
              type: integer
              format: int32
            language:
              type: string
            message:
              type: string
              examples:
                - The provided Api-Key is invalid or expired
            principal:
              $ref: '#/components/schemas/ErrorPrincipal'
            rbaDecision:
              type: string
            rbaLevel:
              type: string
            rbaReasonType:
              type: string
            site:
              type: string
            subIssuerCode:
              type: string
            tokenPan:
              type: string
            urlSite:
              type: string
        success:
          type: integer
          format: int32
          examples:
            - 3
    RbaAdminResponseServiceBoolean:
      type: object
      properties:
        error:
          type: object
          properties:
            authMeans:
              type: array
              items:
                type: string
            authentId:
              type: string
            blackListStatus:
              type: array
              items:
                type: string
            cardHolderId:
              type: string
            comment:
              type: string
            errorCode:
              type: string
              description: |
                Here is the list of defined functional error codes and their meaning:
                <details>
                  <summary>Click to expand</summary>
                  | Error code | Description |
                  | --- | --- |
                  | 403000000 | The provided Api-Key is invalid or expired | 
                  | 400010005 | Bad parameter |
                  | 400050002 | Bad parameter : Blacklist Type |
                  | 400050005 | Bad parameter : Service Code |
                  | 404000000 | Service not found |
                </details>
              examples:
                - 403000000
            extRbaDecision:
              type: string
            extRbaLevel:
              type: integer
              format: int32
            externalWSResponse:
              type: string
            id:
              type: string
            issuerCode:
              type: string
            issuerRbaDecision:
              type: string
            issuerRbaLevel:
              type: integer
              format: int32
            language:
              type: string
            message:
              type: string
              examples:
                - The provided Api-Key is invalid or expired
            principal:
              $ref: '#/components/schemas/ErrorPrincipal'
            rbaDecision:
              type: string
            rbaLevel:
              type: string
            rbaReasonType:
              type: string
            site:
              type: string
            subIssuerCode:
              type: string
            tokenPan:
              type: string
            urlSite:
              type: string
        success:
          type: boolean
          examples:
            - false
    # Schemas define the structure of response ServiceDTP
    RbaAdminResponseServiceServiceDTO:
      type: object
      properties:
        error:
          type: object
          properties:
            authMeans:
              type: array
              items:
                type: string
            authentId:
              type: string
            blackListStatus:
              type: array
              items:
                type: string
            cardHolderId:
              type: string
            comment:
              type: string
            errorCode:
              type: string
              description: |
                Here is the list of defined functional error codes and their meaning:
                <details>
                  <summary>Click to expand</summary>
                  | Error code | Description |
                  | --- | --- |
                  | 403000000 | The provided Api-Key is invalid or expired | 
                  | 400010005 | Bad parameter |
                  | 404000000 | Service not found |
                  | 409010000 | There is service already exists with the same label |
                </details>
              examples:
                - 403000000
            extRbaDecision:
              type: string
            extRbaLevel:
              type: integer
              format: int32
            externalWSResponse:
              type: string
            id:
              type: string
            issuerCode:
              type: string
            issuerRbaDecision:
              type: string
            issuerRbaLevel:
              type: integer
              format: int32
            language:
              type: string
            message:
              type: string
              examples:
                - The provided Api-Key is invalid or expired
            principal:
              $ref: '#/components/schemas/ErrorPrincipal'
            rbaDecision:
              type: string
            rbaLevel:
              type: string
            rbaReasonType:
              type: string
            site:
              type: string
            subIssuerCode:
              type: string
            tokenPan:
              type: string
            urlSite:
              type: string
        success:
          $ref: '#/components/schemas/ServiceResponseDTO'
    # Schemas define the structure of request ConfigDTO
    ConfigDTO:
      required:
        - entry
        - id
        - service
        - issuer
        - subIssuer
        - value
      type: object
      properties:
        createdTime:
          type: string
          description: Config dto createdTime
          format: date-time
          examples:
            - 2024-09-27T11:14:32.919Z
        deletedTime:
          type: string
          description: Config dto deletedTime
          format: date-time
          examples:
            - 2024-09-27T11:14:32.919Z
        entry:
          type: string
          description: Config dto entry
          examples:
            - entry value
        id:
          type: integer
          description: Config dto identifier
          format: int64
          examples:
            - 2
        issuer:
          type: string
          description: Config dto issuer
          length: 5
          examples:
            - 66666
        service:
          type: string
          description: Config dto service code
          minLength: 1
          maxLength: 255
          pattern: '^[A-Z\d]{3}_[A-Z\d]{3}(?:_[A-Z\d]+)*$'
          examples:
            - HUB_NRT
        subIssuer:
          type: string
          description: Config dto subIssuer
          length: 5
          examples:
            - 6666
        updatedTime:
          type: string
          description: Config dto updatedTime
          format: date-time
          examples:
            - 2024-09-27T11:14:32.919Z
        value:
          type: string
          description: Config dto value
          examples:
            - value
      description: Config DTO resource representation
    # Schemas define the structure of response ConfigDTO
    ConfigResponseDTO:
      type: object
      properties:
        createdTime:
          type: string
          description: Config dto createdTime
          format: date-time
          examples:
            - 2024-09-27T11:14:32.919Z
        deletedTime:
          type: string
          description: Config dto deletedTime
          format: date-time
          examples:
            - 2024-09-27T11:14:32.919Z
        entry:
          type: string
          description: Config dto entry
          examples:
            - entry value
        id:
          type: integer
          description: Config dto identifier
          format: int64
          examples:
            - 2
        issuer:
          type: string
          description: Config dto issuer
          examples:
            - 66666
        service:
          type: string
          description: Config dto service code
          examples:
            - HUB_NRT
        subIssuer:
          type: string
          description: Config dto subIssuer
          examples:
            - 6666
        updatedTime:
          type: string
          description: Config dto updatedTime
          format: date-time
          examples:
            - 2024-09-27T11:14:32.919Z
        value:
          type: string
          description: Config dto value
          examples:
            - AUTOMATIC_BLACKLIST_DURATION
      description: Config DTO resource representation
    ConfigResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            authMeans:
              type: array
              items:
                type: string
            authentId:
              type: string
            blackListStatus:
              type: array
              items:
                type: string
            cardHolderId:
              type: string
            comment:
              type: string
            errorCode:
              type: string
              description: |
                Here is the list of defined functional error codes and their meaning:
                <details>
                  <summary>Click to expand</summary>
                  | Error code | Description |
                  | --- | --- |
                  | 403000000 | The provided Api-Key is invalid or expired | 
                  | 400090051 | Bad parameter : Undefined config. |
                  | 400090052 | Bad parameter : Undefined config ID |
                  | 400090053 | Bad parameter : Undefined config Service |
                  | 400090054 | Bad parameter : Undefined config Issuer |
                  | 400090056 | Bad parameter : Undefined config entry |
                  | 400090058 | Bad parameter : Invalid config value duration: number(3) |
                  | 400090057 | Bad parameter : Invalid config value :boolean |
                  | 400090059 | Bad parameter : Config already exists |
                  | 520000000 | Unexpected error |
                </details>
              examples:
                - 403000000
            extRbaDecision:
              type: string
            extRbaLevel:
              type: integer
              format: int32
            externalWSResponse:
              type: string
            id:
              type: string
            issuerCode:
              type: string
            issuerRbaDecision:
              type: string
            issuerRbaLevel:
              type: integer
              format: int32
            language:
              type: string
            message:
              type: string
              examples:
                - The provided Api-Key is invalid or expired
            principal:
              $ref: '#/components/schemas/ErrorPrincipal'
            rbaDecision:
              type: string
            rbaLevel:
              type: string
            rbaReasonType:
              type: string
            site:
              type: string
            subIssuerCode:
              type: string
            tokenPan:
              type: string
            urlSite:
              type: string
        success:
          $ref: '#/components/schemas/ConfigResponseDTO'
    ConfigListResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            authMeans:
              type: array
              items:
                type: string
            authentId:
              type: string
            blackListStatus:
              type: array
              items:
                type: string
            cardHolderId:
              type: string
            comment:
              type: string
            errorCode:
              type: string
              description: |
                Here is the list of defined functional error codes and their meaning:
                <details>
                  <summary>Click to expand</summary>
                  | Error code | Description |
                  | --- | --- |
                  | 403000000 | The provided Api-Key is invalid or expired | 
                  | 400010005 | Bad parameter |
                  | 520000000 | Unexpected error. |
                </details>
              examples:
                - 403000000
            extRbaDecision:
              type: string
            extRbaLevel:
              type: integer
              format: int32
            externalWSResponse:
              type: string
            id:
              type: string
            issuerCode:
              type: string
            issuerRbaDecision:
              type: string
            issuerRbaLevel:
              type: integer
              format: int32
            language:
              type: string
            message:
              type: string
              examples:
                - The provided Api-Key is invalid or expired
            principal:
              $ref: '#/components/schemas/ErrorPrincipal'
            rbaDecision:
              type: string
            rbaLevel:
              type: string
            rbaReasonType:
              type: string
            site:
              type: string
            subIssuerCode:
              type: string
            tokenPan:
              type: string
            urlSite:
              type: string
        success:
          type: array
          items:
            $ref: '#/components/schemas/ConfigResponseDTO'
    # Schemas define the structure of request Counters
    TransactionActivityRequest:
      type: object
      properties:
        service:
          type: string
          description: TransactionActivityRequest count
          minLength: 1
          maxLength: 255
          pattern: '^[A-Z\d]{3}_[A-Z\d]{3}(?:_[A-Z\d]+)*$'
          examples:
            - HUB_NRT
        tokenPan:
          type: string
          description: TransactionActivityRequest tokenPan
          examples:
            - mckNDk3NjcwMDAwMDAwMDEwNg==
      description: TransactionActivityRequest resource representation
    # Schemas define the structure of response Counters
    TransactionActivityDTO:
      type: object
      properties:
        count:
          type: integer
          description: TransactionActivityDTO count
          format: int32
          examples:
            - 2
        totalAmount:
          type: integer
          description: TransactionActivityDTO total amount
          format: int64
          examples:
            - 10
      description: TransactionActivityDTO resource representation
    CTACountersResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            authMeans:
              type: array
              items:
                type: string
            authentId:
              type: string
            blackListStatus:
              type: array
              items:
                type: string
            cardHolderId:
              type: string
            comment:
              type: string
            errorCode:
              type: string
              description: |
                Here is the list of defined functional error codes and their meaning:
                <details>
                  <summary>Click to expand</summary>
                  | Error code | Description |
                  | --- | --- |
                  | 404000000 | Service not found | 
                  | 404060012 | CTA counters not found. |
                </details>
              examples:
                - 404000000
            extRbaDecision:
              type: string
            extRbaLevel:
              type: integer
              format: int32
            externalWSResponse:
              type: string
            id:
              type: string
            issuerCode:
              type: string
            issuerRbaDecision:
              type: string
            issuerRbaLevel:
              type: integer
              format: int32
            language:
              type: string
            message:
              type: string
              examples:
                - The provided Api-Key is invalid or expired
            principal:
              $ref: '#/components/schemas/ErrorPrincipal'
            rbaDecision:
              type: string
            rbaLevel:
              type: string
            rbaReasonType:
              type: string
            site:
              type: string
            subIssuerCode:
              type: string
            tokenPan:
              type: string
            urlSite:
              type: string
        transactionActivity:
          $ref: '#/components/schemas/TransactionActivityDTO'
    # Schemas define the structure of request Eligible merchant
    UpdateEligibleMerchantRequestDTO:
      required:
        - id
        - payeeType
        - payeeValue
        - service
      type: object
      properties:
        categories:
          uniqueItems: true
          type: array
          description: UpdateEligibleMerchantRequestDTO categories
          items:
            type: string
            description: UpdateEligibleMerchantRequestDTO categories
            enum:
              - SECURE_CORPORATE
              - TRUSTED_BENEFICIARIES_ACS
              - TRUSTED_BENEFICIARIES_3DS_SERVER
              - DELEGATED_AUTHENTICATION
              - TRA
              - RISK
              - LEVEL_1
              - LEVEL_2
              - LEVEL_3
              - LEVEL_4
              - LEVEL_5
          examples:
            - [ SECURE_CORPORATE,TRUSTED_BENEFICIARIES_ACS ]
        id:
          type: integer
          description: UpdateEligibleMerchantRequestDTO id
          format: int64
          examples:
            - 2
        issuer:
          type: string
          description: UpdateEligibleMerchantRequestDTO issuer
          length: 5
          examples:
            - 66666
        payeeType:
          type: string
          description: UpdateEligibleMerchantRequestDTO payee type
          enum:
            - MERCHANT_ID
            - MERCHANT_URL
            - MERCHANT_NAME
            - MERCHANT_MCC
            - MERCHANT_URL_CONTAINS
            - MERCHANT_URL_STARTS
            - MERCHANT_URL_ENDS
          examples:
            - MERCHANT_ID
        payeeValue:
          type: string
          description: UpdateEligibleMerchantRequestDTO payee value
          examples:
            - value
        service:
          type: string
          description: UpdateEligibleMerchantRequestDTO service
          maxLength: 255
          minLength: 1
          pattern: '^[A-Z\d]{3}_[A-Z\d]{3}(?:_[A-Z\d]+)*$'
          examples:
            - HUB_NRT
        subIssuer:
          type: string
          description: UpdateEligibleMerchantRequestDTO sub issuer
          length: 5
          examples:
            - 66666
      description: UpdateEligibleMerchantRequestDTO resource representation
    SearchEligibleMerchantsByPayeeRequestDTO:
      required:
        - service
      type: object
      properties:
        categories:
          type: array
          description: SearchEligibleMerchantsByPayeeRequestDTO category type list
          items:
            type: string
            description: SearchEligibleMerchantsByPayeeRequestDTO category type list
            enum:
              - SECURE_CORPORATE
              - TRUSTED_BENEFICIARIES_ACS
              - TRUSTED_BENEFICIARIES_3DS_SERVER
              - DELEGATED_AUTHENTICATION
              - TRA
              - RISK
              - LEVEL_1
              - LEVEL_2
              - LEVEL_3
              - LEVEL_4
              - LEVEL_5
          examples:
            - [ SECURE_CORPORATE,TRUSTED_BENEFICIARIES_ACS ]
        issuer:
          type: string
          description: SearchEligibleMerchantsByPayeeRequestDTO issuer
          length: 5
          examples:
            - 66666
        payeeValue:
          type: string
          description: SearchEligibleMerchantsByPayeeRequestDTO payee value
          examples:
            - value
        service:
          type: string
          description: SearchEligibleMerchantsByPayeeRequestDTO service code
          maxLength: 255
          minLength: 1
          pattern: '^[A-Z\d]{3}_[A-Z\d]{3}(?:_[A-Z\d]+)*$'
          examples:
            - HUB_NRT
        size:
          type: integer
          description: SearchEligibleMerchantsByPayeeRequestDTO size
          format: int32
          examples:
            - 100
        start:
          type: integer
          description: SearchEligibleMerchantsByPayeeRequestDTO start
          format: int32
          examples:
            - 0
        subIssuer:
          type: string
          description: SearchEligibleMerchantsByPayeeRequestDTO sub issuer
          length: 5
          examples:
            - 66666
      description: SearchEligibleMerchantsByPayeeRequestDTO resource representation
    SearchEligibleMerchantsRequestDTO:
      required:
        - service
      type: object
      properties:
        categories:
          type: array
          description: SearchEligibleMerchantsRequestDTO category type list
          items:
            type: string
            description: SearchEligibleMerchantsRequestDTO category type list
            enum:
              - SECURE_CORPORATE
              - TRUSTED_BENEFICIARIES_ACS
              - TRUSTED_BENEFICIARIES_3DS_SERVER
              - DELEGATED_AUTHENTICATION
              - TRA
              - RISK
              - LEVEL_1
              - LEVEL_2
              - LEVEL_3
              - LEVEL_4
              - LEVEL_5
          examples:
            - [SECURE_CORPORATE,TRUSTED_BENEFICIARIES_ACS]
        issuer:
          type: string
          description: SearchEligibleMerchantsRequestDTO issuer
          length: 5
          examples:
            - 66666
        payeeType:
          type: string
          description: SearchEligibleMerchantsRequestDTO payee type
          enum:
            - MERCHANT_ID
            - MERCHANT_URL
            - MERCHANT_NAME
            - MERCHANT_MCC
            - MERCHANT_URL_CONTAINS
            - MERCHANT_URL_STARTS
            - MERCHANT_URL_ENDS
          examples:
            - MERCHANT_ID
        payeeValue:
          type: string
          description: SearchEligibleMerchantsRequestDTO payee value
          examples:
            - value
        service:
          type: string
          description: SearchEligibleMerchantsRequestDTO service code
          maxLength: 255
          minLength: 1
          pattern: '^[A-Z\d]{3}_[A-Z\d]{3}(?:_[A-Z\d]+)*$'
          examples:
            - HUB_NRT
        size:
          type: integer
          description: SearchEligibleMerchantsRequestDTO size
          format: int32
          examples:
            - 100
        start:
          type: integer
          description: SearchEligibleMerchantsRequestDTO start
          format: int32
          examples:
            - 0
        subIssuer:
          type: string
          description: SearchEligibleMerchantsRequestDTO sub issuer
          length: 5
          examples:
            - 66666
      description: SearchEligibleMerchantsRequestDTO resource representation
    # Schemas define the structure of response Eligible merchant
    EligibleMerchantDTO:
      type: object
      properties:
        categories:
          type: array
          description: EligibleMerchantDTO categories
          items:
            type: string
            description: EligibleMerchantDTO categories
            enum:
              - SECURE_CORPORATE
              - TRUSTED_BENEFICIARIES_ACS
              - TRUSTED_BENEFICIARIES_3DS_SERVER
              - DELEGATED_AUTHENTICATION
              - TRA
              - RISK
              - LEVEL_1
              - LEVEL_2
              - LEVEL_3
              - LEVEL_4
              - LEVEL_5
          examples:
            - [SECURE_CORPORATE]
        createdTime:
          type: string
          description: EligibleMerchantDTO created time
          format: yyyy-MM-dd'T'HH:mm:ss.SSSZ
          examples:
            - 2024-09-25T18:53:52.674+0300
        id:
          type: integer
          description: EligibleMerchantDTO id
          format: int64
          examples:
            - 1
        issuer:
          type: string
          description: EligibleMerchantDTO issuer
          maxLength: 5
          examples:
            - 66666
        payeeType:
          type: string
          description: EligibleMerchantDTO payee type
          enum:
            - MERCHANT_ID
            - MERCHANT_URL
            - MERCHANT_NAME
            - MERCHANT_MCC
            - MERCHANT_URL_CONTAINS
            - MERCHANT_URL_STARTS
            - MERCHANT_URL_ENDS
          examples:
            - MERCHANT_ID
        payeeValue:
          type: string
          description: EligibleMerchantDTO payee value
          examples:
            - value
        service:
          type: string
          description: EligibleMerchantDTO service code
          maxLength: 255
          minLength: 1
          examples:
            - HUB_NRT
        subIssuer:
          type: string
          description: EligibleMerchantDTO sub issuer
          maxLength: 5
          examples:
            - 66666
        updatedTime:
          type: string
          description: EligibleMerchantDTO updated time
          format: yyyy-MM-dd'T'HH:mm:ss.SSSZ
          examples:
            - 2024-09-25T18:53:52.674+0300
      description: EligibleMerchantDTO resource representation
    SearchEligibleMerchantsResponseDTO:
      type: object
      properties:
        count:
          type: integer
          description: SearchEligibleMerchantsResponseDTO count
          format: int64
          examples:
            - 1
        merchants:
          type: array
          description: SearchEligibleMerchantsResponseDTO merchants
          items:
            $ref: '#/components/schemas/EligibleMerchantDTO'
    EligibleMerchantListResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            authMeans:
              type: array
              items:
                type: string
            authentId:
              type: string
            blackListStatus:
              type: array
              items:
                type: string
            cardHolderId:
              type: string
            comment:
              type: string
            errorCode:
              type: string
              description: |
                Here is the list of defined functional error codes and their meaning:
                <details>
                  <summary>Click to expand</summary>
                  | Error code | Description |
                  | --- | --- |
                  | 403000000 | The provided Api-Key is invalid or expired | 
                  | 400100000 | Bad request : Invalid incoming request | 
                  | 400010005 | Bad parameter |
                  | 400010010 | Bad parameter : issuer code |
                  | 400010011 | Bad parameter : subIssuer code |
                </details>
              examples:
                - 403000000
            extRbaDecision:
              type: string
            extRbaLevel:
              type: integer
              format: int32
            externalWSResponse:
              type: string
            id:
              type: string
            issuerCode:
              type: string
            issuerRbaDecision:
              type: string
            issuerRbaLevel:
              type: integer
              format: int32
            language:
              type: string
            message:
              type: string
              examples:
                - The provided Api-Key is invalid or expired
            principal:
              $ref: '#/components/schemas/ErrorPrincipal'
            rbaDecision:
              type: string
            rbaLevel:
              type: string
            rbaReasonType:
              type: string
            site:
              type: string
            subIssuerCode:
              type: string
            tokenPan:
              type: string
            urlSite:
              type: string
        success:
          $ref: '#/components/schemas/SearchEligibleMerchantsResponseDTO'
    # Schemas define the structure of request Issuer config
    IssuerConfigDTO:
      required:
        - id
        - interfaceType
        - service
        - defaultDecision
      type: object
      properties:
        active:
          type: boolean
          description: Flag indicating whether IssuerConfig is active
          examples:
            - true
        alwaysRetrieveExternalScoring:
          type: boolean
          description: Indicates whether the external service is available or not
          examples:
            - false
        bypass3DS1:
          type: boolean
          description:  Flag to bypass Ext Scoring request for protocol 1.0.2
          examples:
            - false
        bypassVPAN:
          type: boolean
          description:  bypass VPAN
          examples:
            - false
        createdTime:
          type: string
          description:  created time not used for update
          format: yyyy-MM-dd'T'HH:mm:ss.SSSZ
          examples:
            - 2024-09-25T18:53:52.674+0300
        defaultDecision:
          type: string
          description: The default decision if there is neither external nor provided one.
          enum:
            - FRICTIONLESS
            - SCA
            - DECLINE
            - EXTRBADECISION
          examples:
            - FRICTIONLESS
        defaultScore:
          type: integer
          description: The default score value if there is neither external score nor provided one
          format: int32
          minimum: 0
          maximum: 100
          examples:
            - 80
        deletedTime:
          type: string
          description: deleted time not used for update
          format: yyyy-MM-dd'T'HH:mm:ss.SSSZ
          examples:
            - 2024-09-25T18:53:52.674+0300
        eligibleMerchantActive:
          type: boolean
          description: If active then Trusted Beneficiaries is limited to a list of eligible merchants
          examples:
            - true
        id:
          type: integer
          description: Identifier
          format: int64
          examples:
            - 5
        interfaceType:
          type: string
          description: Type of interface for authentication
          enum:
            - THREE_DS
            - ONLINE_BANKING
          examples:
            - ONLINE_BANKING
        issuer:
          type: string
          description: Issuer code,  ** if subIssuer has value, issuer value is mandatory
          length: 5
          examples:
            - 66666
        originPriority:
          type: array
          description: Indicates the priority of scoring service. A list of enum.  Contains the list elements in order of priority
          items:
            type: string
            description: IssuerConfigDTO origin priority
            enum:
              - DS
              - DS_CB
              - DS_CB_BANK
              - DS_VISA
              - DS_MASTERCARD
              - EXTERNAL
              - ISSUER
              - DS_ISSUER
              - EXTERNAL_ISSUER
          examples:
            - [ DS ]
        relevantScore:
          type: boolean
          description: Indicates whether the score is relevant or not, it means if external scoring service is activated, do we have to take score into account
          examples:
            - false
        scoringProviders:
          type: array
          description: ScoringProviderDTO scoring providers
          items:
            $ref: '#/components/schemas/ScoringProviderDTO'
        service:
          type: string
          description: Service code
          minLength: 1
          maxLength: 255
          pattern: '^[A-Z\d]{3}_[A-Z\d]{3}(?:_[A-Z\d]+)*$'
          examples:
            - HUB_NRT
        skipCounters:
          type: boolean
          description: Flag to indicate do we have to take transaction activity counters into account or not
          examples:
            - false
        subIssuer:
          type: string
          description: Sub-issuer code
          length: 5
          examples:
            - 66666
        trustedBeneficiariesActive:
          type: boolean
          description: "Request for Trusted Beneficiaries list is optional depending on the value of this flag: if YES then the list of TB is retrieved."
          examples:
            - false
        updatedTime:
          type: string
          description:  updated time not used
          format: yyyy-MM-dd'T'HH:mm:ss.SSSZ
          examples:
            - 2024-09-25T18:53:52.674+0300
      description: IssuerConfigDTO resource representation
    # Schemas define the structure of response Issuer config
    IssuerConfigResponseDTO:
      type: object
      properties:
        active:
          type: boolean
          description: Flag indicating whether IssuerConfig is active
          examples:
            - true
        alwaysRetrieveExternalScoring:
          type: boolean
          description: Indicates whether the external service is available or not
          examples:
            - false
        bypass3DS1:
          type: boolean
          description: Flag to bypass Ext Scoring request for protocol 1.0.2
          examples:
            - false
        bypassVPAN:
          type: boolean
          description: bypass VPAN
          examples:
            - false
        createdTime:
          type: string
          description: created time
          format: yyyy-MM-dd'T'HH:mm:ss.SSSZ
          examples:
            - 2024-09-25T18:53:52.674+0300
        defaultDecision:
          type: string
          description: The default decision if there is neither external nor provided one.
          enum:
            - FRICTIONLESS
            - SCA
            - DECLINE
            - EXTRBADECISION
          examples:
            - FRICTIONLESS
        defaultScore:
          type: integer
          description: The default score value if there is neither external score nor provided one
          format: int32
          minimum: 0
          maximum: 100
          examples:
            - 80
        deletedTime:
          type: string
          description: deleted time
          format: yyyy-MM-dd'T'HH:mm:ss.SSSZ
          examples:
            - 2024-09-25T18:53:52.674+0300
        eligibleMerchantActive:
          type: boolean
          description: If active then Trusted Beneficiaries is limited to a list of eligible merchants
          examples:
            - true
        id:
          type: integer
          description: Identifier
          format: int64
          examples:
            - 5
        interfaceType:
          type: string
          description: Type of interface for authentication
          enum:
            - THREE_DS
            - ONLINE_BANKING
          examples:
            - ONLINE_BANKING
        issuer:
          type: string
          description: Issuer code,  ** if subIssuer has value, issuer value is mandatory
          length: 5
          examples:
            - 66666
        originPriority:
          type: array
          description: Indicates the priority of scoring service. A list of enum.  Contains the list elements in order of priority
          items:
            type: string
            description: IssuerConfigDTO origin priority
            enum:
              - DS
              - DS_CB
              - DS_CB_BANK
              - DS_VISA
              - DS_MASTERCARD
              - EXTERNAL
              - ISSUER
              - DS_ISSUER
              - EXTERNAL_ISSUER
          examples:
            - [ DS ]
        relevantScore:
          type: boolean
          description: Indicates whether the score is relevant or not, it means if external scoring service is activated, do we have to take score into account
          examples:
            - false
        scoringProviders:
          type: array
          description: ScoringProviderDTO scoring providers
          items:
            $ref: '#/components/schemas/ScoringProviderDTO'
        service:
          type: string
          description: Service code
          minLength: 1
          maxLength: 255
          examples:
            - HUB_NRT
        skipCounters:
          type: boolean
          description: Flag to indicate do we have to take transaction activity counters into account or not
          examples:
            - false
        subIssuer:
          type: string
          description: Sub-issuer code
          length: 5
          examples:
            - 66666
        trustedBeneficiariesActive:
          type: boolean
          description: "Request for Trusted Beneficiaries list is optional depending on the value of this flag: if YES then the list of TB is retrieved."
          examples:
            - false
        updatedTime:
          type: string
          description: updated time
          format: yyyy-MM-dd'T'HH:mm:ss.SSSZ
          examples:
            - 2024-09-25T18:53:52.674+0300
      description: IssuerConfigDTO resource representation
    IssuerConfigResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            authMeans:
              type: array
              items:
                type: string
            authentId:
              type: string
            blackListStatus:
              type: array
              items:
                type: string
            cardHolderId:
              type: string
            comment:
              type: string
            errorCode:
              type: string
              description: |
                Here is the list of defined functional error codes and their meaning:
                <details>
                  <summary>Click to expand</summary>
                  | Error code | Description |
                  | --- | --- |
                  | 403000000 | The provided Api-Key is invalid or expired | 
                  | 400010005 | Bad parameter |
                  | 400050517 | RBA issuer config id cannot be null. |
                  | 400050531 | RBA issuer config not found. |
                </details>
              examples:
                - 403000000
            extRbaDecision:
              type: string
            extRbaLevel:
              type: integer
              format: int32
            externalWSResponse:
              type: string
            id:
              type: string
            issuerCode:
              type: string
            issuerRbaDecision:
              type: string
            issuerRbaLevel:
              type: integer
              format: int32
            language:
              type: string
            message:
              type: string
              examples:
                - The provided Api-Key is invalid or expired
            principal:
              $ref: '#/components/schemas/ErrorPrincipal'
            rbaDecision:
              type: string
            rbaLevel:
              type: string
            rbaReasonType:
              type: string
            site:
              type: string
            subIssuerCode:
              type: string
            tokenPan:
              type: string
            urlSite:
              type: string
        success:
          $ref: '#/components/schemas/IssuerConfigResponseDTO'
    IssuerConfigListResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            authMeans:
              type: array
              items:
                type: string
            authentId:
              type: string
            blackListStatus:
              type: array
              items:
                type: string
            cardHolderId:
              type: string
            comment:
              type: string
            errorCode:
              type: string
              description: |
                Here is the list of defined functional error codes and their meaning:
                <details>
                  <summary>Click to expand</summary>
                  | Error code | Description |
                  | --- | --- |
                  | 403000000 | The provided Api-Key is invalid or expired | 
                  | 400010005 | Bad parameter |
                  | 400050519 | RBA issuer config service cannot be null or empty. |
                  | 400050520 | RBA issuer config issuer cannot be null or empty when sub issuer provided. |
                </details>
              examples:
                - 403000000
            extRbaDecision:
              type: string
            extRbaLevel:
              type: integer
              format: int32
            externalWSResponse:
              type: string
            id:
              type: string
            issuerCode:
              type: string
            issuerRbaDecision:
              type: string
            issuerRbaLevel:
              type: integer
              format: int32
            language:
              type: string
            message:
              type: string
              examples:
                - The provided Api-Key is invalid or expired
            principal:
              $ref: '#/components/schemas/ErrorPrincipal'
            rbaDecision:
              type: string
            rbaLevel:
              type: string
            rbaReasonType:
              type: string
            site:
              type: string
            subIssuerCode:
              type: string
            tokenPan:
              type: string
            urlSite:
              type: string
        success:
          type: array
          items:
            $ref: '#/components/schemas/IssuerConfigResponseDTO'
    # Schemas define the structure of request Score config
    ScoringProviderDTO:
      required:
        - scoreType
        - providerType
        - scoreServiceUrl
        - adviceServiceUrl
      type: object
      properties:
        active:
          type: boolean
          description: Flag indicating whether ScoringProvider is active
          examples:
            - true
        adviceServiceUrl:
          type: string
          description: The default score value if there is neither external score nor provided one
          examples:
            - http://authent-hub-mockserver:1080/inform-advice-new/
        bypassNPA:
          type: boolean
          description: If TRUE  then call of the scoring provider must be bypassed.
        bypassSCHEME:
          type: string
          description:  bypass SCHEME
          examples:
            - value
        createdTime:
          type: string
          description: created time not used
          format: date-time
        deletedTime:
          type: string
          description:  deleted time not used
          format: date-time
        id:
          type: integer
          description: Identifier
          format: int64
          examples:
            - 2
        ordinal:
          type: integer
          description: Ordinal number of the Scoring Provider
          format: int32
          examples:
            - 1
        providerType:
          type: string
          description: The scoring platform
          enum:
            - STET
            - SCORINGSTD
            - INFORM
            - MOCK
          examples:
            - STET
        scoreServiceUrl:
          type: string
          description: The default score value if there is neither external score nor provided one
          examples:
            -  http://authent-hub-mockserver:1080/inform-scoring-new/
        scoreType:
          type: string
          description: Type of score returned by the scoring provider.
          enum:
            - ISSUER
            - EXTERNAL
          examples:
            - EXTERNAL
        updatedTime:
          type: string
          description: updated time not used
          format: date-time
      description: ScoringProviderDTO resource representation
    ScoreConfigDTO:
      required:
        - id
        - service
        - interfaceType
        - providerType
        - scoreServiceUrl
        - adviceServiceUrl
        - defaultDecision
      type: object
      properties:
        active:
          type: boolean
          examples:
            - true
        adviceServiceUrl:
          type: string
          examples:
            - http://authent-hub-mockserver:1080/inform-advice-new/
        alwaysRetrieveExternalScoring:
          type: boolean
        bypass3DS1:
          type: boolean
        createdTime:
          type: string
          format: yyyy-MM-dd'T'HH:mm:ss.SSSZ
          examples:
            - 2021-12-09T15:39:48.000+0300
        defaultDecision:
          type: string
          enum:
            - FRICTIONLESS
            - SCA
            - DECLINE
            - EXTRBADECISION
          examples:
            - FRICTIONLESS
        defaultScore:
          type: integer
          format: int32
          examples:
            - 60
        deletedTime:
          type: string
          format: yyyy-MM-dd'T'HH:mm:ss.SSSZ
          examples:
            - 2021-12-09T15:39:48.000+0300
        eligibleMerchantActive:
          type: boolean
        id:
          type: integer
          description: identifier , required for update
          format: int64
          examples:
            - 1
        important:
          type: boolean
        interfaceType:
          type: string
          enum:
            - THREE_DS
            - ONLINE_BANKING
          examples:
            - THREE_DS
        issuer:
          type: string
          length: 5
          description: issuer code , required if sub issuer is provided
          examples:
            - 66666
        originPriority:
          type: array
          items:
            type: string
            enum:
              - DS
              - DS_CB
              - DS_CB_BANK
              - DS_VISA
              - DS_MASTERCARD
              - EXTERNAL
              - ISSUER
              - DS_ISSUER
              - EXTERNAL_ISSUER
            examples:
              - [DS]
        providerType:
          type: string
          enum:
            - STET
            - SCORINGSTD
            - INFORM
            - MOCK
          examples:
            - STET
        relevantScore:
          type: boolean
        scoreServiceUrl:
          type: string
          examples:
            -  http://authent-hub-mockserver:1080/inform-scoring-new/
        service:
          type: string
          minLength: 1
          maxLength: 255
          pattern: '^[A-Z\d]{3}_[A-Z\d]{3}(?:_[A-Z\d]+)*$'
          examples:
            - HUB_NRT
        skipCounters:
          type: boolean
        subIssuer:
          type: string
        trustedBeneficiariesActive:
          type: boolean
        updatedTime:
          type: string
          format: yyyy-MM-dd'T'HH:mm:ss.SSSZ
          examples:
            - 2021-12-09T15:39:48.000+0300
    # Schemas define the structure of response Score config
    ScoreConfigResponseDTO:
      type: object
      properties:
        active:
          type: boolean
          examples:
            - true
        adviceServiceUrl:
          type: string
          examples:
            - http://authent-hub-mockserver:1080/inform-advice-new/
        alwaysRetrieveExternalScoring:
          type: boolean
        bypass3DS1:
          type: boolean
        createdTime:
          type: string
          format: yyyy-MM-dd'T'HH:mm:ss.SSSZ
          examples:
            - 2021-12-09T15:39:48.000+0300
        defaultDecision:
          type: string
          enum:
            - FRICTIONLESS
            - SCA
            - DECLINE
            - EXTRBADECISION
          examples:
            - FRICTIONLESS
        defaultScore:
          type: integer
          format: int32
          examples:
            - 60
        deletedTime:
          type: string
          format: yyyy-MM-dd'T'HH:mm:ss.SSSZ
          examples:
            - 2021-12-09T15:39:48.000+0300
        eligibleMerchantActive:
          type: boolean
        id:
          type: integer
          description: identifier , required for update
          format: int64
          examples:
            - 1
        important:
          type: boolean
        interfaceType:
          type: string
          enum:
            - THREE_DS
            - ONLINE_BANKING
          examples:
            - THREE_DS
        issuer:
          type: string
          length: 5
          description: issuer code , required if sub issuer is provided
          examples:
            - 66666
        originPriority:
          type: array
          items:
            type: string
            enum:
              - DS
              - DS_CB
              - DS_CB_BANK
              - DS_VISA
              - DS_MASTERCARD
              - EXTERNAL
              - ISSUER
              - DS_ISSUER
              - EXTERNAL_ISSUER
            examples:
              - [ DS ]
        providerType:
          type: string
          enum:
            - STET
            - SCORINGSTD
            - INFORM
            - MOCK
          examples:
            - STET
        relevantScore:
          type: boolean
        scoreServiceUrl:
          type: string
          examples:
            - http://authent-hub-mockserver:1080/inform-scoring-new/
        service:
          type: string
          minLength: 1
          maxLength: 255
          pattern: '^[A-Z\d]{3}_[A-Z\d]{3}(?:_[A-Z\d]+)*$'
          examples:
            - HUB_NRT
        skipCounters:
          type: boolean
        subIssuer:
          type: string
        trustedBeneficiariesActive:
          type: boolean
        updatedTime:
          type: string
          format: yyyy-MM-dd'T'HH:mm:ss.SSSZ
          examples:
            - 2021-12-09T15:39:48.000+0300
    ScoreConfigResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            authMeans:
              type: array
              items:
                type: string
            authentId:
              type: string
            blackListStatus:
              type: array
              items:
                type: string
            cardHolderId:
              type: string
            comment:
              type: string
            errorCode:
              type: string
              description: |
                Here is the list of defined functional error codes and their meaning:
                <details>
                  <summary>Click to expand</summary>
                  | Error code | Description |
                  | --- | --- |
                  | 403000000 | The provided Api-Key is invalid or expired | 
                  | 400010005 | Bad parameter |
                  | 400050531 | RBA issuer config not found. |
                </details>
              examples:
                - 403000000
            extRbaDecision:
              type: string
            extRbaLevel:
              type: integer
              format: int32
            externalWSResponse:
              type: string
            id:
              type: string
            issuerCode:
              type: string
            issuerRbaDecision:
              type: string
            issuerRbaLevel:
              type: integer
              format: int32
            language:
              type: string
            message:
              type: string
              examples:
                - The provided Api-Key is invalid or expired
            principal:
              $ref: '#/components/schemas/ErrorPrincipal'
            rbaDecision:
              type: string
            rbaLevel:
              type: string
            rbaReasonType:
              type: string
            site:
              type: string
            subIssuerCode:
              type: string
            tokenPan:
              type: string
            urlSite:
              type: string
        success:
          $ref: '#/components/schemas/ScoreConfigResponseDTO'
    ScoreConfigListResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            authMeans:
              type: array
              items:
                type: string
            authentId:
              type: string
            blackListStatus:
              type: array
              items:
                type: string
            cardHolderId:
              type: string
            comment:
              type: string
            errorCode:
              type: string
              description: |
                Here is the list of defined functional error codes and their meaning:
                <details>
                  <summary>Click to expand</summary>
                  | Error code | Description |
                  | --- | --- |
                  | 403000000 | The provided Api-Key is invalid or expired | 
                  | 400010005 | Bad parameter |
                </details>
              examples:
                - 403000000
            extRbaDecision:
              type: string
            extRbaLevel:
              type: integer
              format: int32
            externalWSResponse:
              type: string
            id:
              type: string
            issuerCode:
              type: string
            issuerRbaDecision:
              type: string
            issuerRbaLevel:
              type: integer
              format: int32
            language:
              type: string
            message:
              type: string
              examples:
                - The provided Api-Key is invalid or expired
            principal:
              $ref: '#/components/schemas/ErrorPrincipal'
            rbaDecision:
              type: string
            rbaLevel:
              type: string
            rbaReasonType:
              type: string
            site:
              type: string
            subIssuerCode:
              type: string
            tokenPan:
              type: string
            urlSite:
              type: string
        success:
          type: array
          items:
            $ref: '#/components/schemas/ScoreConfigResponseDTO'
    # Schemas define the structure of request Operand value
    OperandValueDTO:
      required:
        - label
        - value
      type: object
      properties:
        id:
          type: integer
          format: int64
          examples:
            - 1
        label:
          type: string
          description:  label of operand value
          examples:
            - label
        ruleSetId:
          type: integer
          description:  rule set id of operand value
          format: int64
          examples:
            - 3
        value:
          type: integer
          description:  value of operand
          format: int64
          examples:
            - value
      description: OperandValueDTO resource representation
    # Schemas define the structure of response Operand value
    OperandValueResponseDTO:
      type: object
      properties:
        id:
          type: integer
          format: int64
          examples:
            - 1
        label:
          type: string
          description: label of operand value
          examples:
            - label
        ruleSetId:
          type: integer
          description: rule set id of operand value
          format: int64
          examples:
            - 3
        value:
          type: integer
          description: value of operand
          format: int64
          examples:
            - value
      description: OperandValueDTO resource representation
    ListOperandValueDTO:
      type: array
      properties:
        empty:
          type: boolean
      items:
        $ref: '#/components/schemas/OperandValueResponseDTO'
    # Schemas define the structure of request Operand
    OperandDTO:
      required:
        - conditionId
        - id
        - name
        - reversed
        - type
      type: object
      properties:
        conditionId:
          type: integer
          description: condition id
          format: int64
          examples:
            - 6
        createdTime:
          type: string
          description: Entity creation time
          format: yyyy-MM-dd'T'HH:mm:ss.SSSZ
          examples:
            - 2021-12-09T15:39:48.000+0300
        deletedTime:
          type: string
          description: Entity deletion time
          format: yyyy-MM-dd'T'HH:mm:ss.SSSZ
          examples:
            - 2021-12-09T15:39:48.000+0300
        id:
          type: integer
          description: Entity id
          format: int64
          examples:
            - 12
        longValue:
          type: integer
          format: int64
          examples:
            - 20000
        name:
          type: string
          description: Operand name
          examples:
            - THREE_RI_DECOUPLED
        operandLabel:
          type: string
          description: operand value label
        operandValue:
          $ref: '#/components/schemas/OperandValueDTO'
        reversed:
          type: boolean
          description: Operand reversed
          examples:
            - false
        type:
          type: string
          description: Operand type
          enum:
            - DEFAULT
            - EQUALS
            - IN
            - STATUS
            - STRICTLY_ABOVE
            - STRICTLY_UNDER
          examples:
            - STATUS
        updatedTime:
          type: string
          description: Entity last update time
          format: yyyy-MM-dd'T'HH:mm:ss.SSSZ
          examples:
            - 2021-12-09T15:39:48.000+0300
        value:
          type: string
          description: Operand value
          examples:
            - 3000
      description: OperandDTO resource representation
    # Schemas define the structure of response Operand
    OperandResponseDTO:
      type: object
      properties:
        conditionId:
          type: integer
          description: condition id
          format: int64
          examples:
            - 6
        createdTime:
          type: string
          description: Entity creation time
          format: yyyy-MM-dd'T'HH:mm:ss.SSSZ
          examples:
            - 2021-12-09T15:39:48.000+0300
        deletedTime:
          type: string
          description: Entity deletion time
          format: yyyy-MM-dd'T'HH:mm:ss.SSSZ
          examples:
            - 2021-12-09T15:39:48.000+0300
        id:
          type: integer
          description: Entity id
          format: int64
          examples:
            - 12
        longValue:
          type: integer
          format: int64
          examples:
            - 20000
        name:
          type: string
          description: Operand name
          examples:
            - THREE_RI_DECOUPLED
        operandLabel:
          type: string
          description: operand value label
        operandValue:
          $ref: '#/components/schemas/OperandValueResponseDTO'
        reversed:
          type: boolean
          description: Operand reversed
          examples:
            - false
        type:
          type: string
          description: Operand type
          enum:
            - DEFAULT
            - EQUALS
            - IN
            - STATUS
            - STRICTLY_ABOVE
            - STRICTLY_UNDER
          examples:
            - STATUS
        updatedTime:
          type: string
          description: Entity last update time
          format: yyyy-MM-dd'T'HH:mm:ss.SSSZ
          examples:
            - 2021-12-09T15:39:48.000+0300
        value:
          type: string
          description: Operand value
          examples:
            - 3000
      description: OperandDTO resource representation
    # Schemas define the structure of request TrustedBeneficiary
    TrustedBeneficiaryDTO:
      required:
        - payee
        - payeeType
        - payer
        - payerRef
        - payerType
        - service
        - type
      type: object
      properties:
        createdTime:
          type: string
          description: TrustedBeneficiary createdTime
          format: yyyy-MM-dd'T'HH:mm:ss.SSSZ
          examples:
            - 2021-12-09T15:39:48.000+0300
        deletedTime:
          type: string
          description: TrustedBeneficiary deletedTime
          format: yyyy-MM-dd'T'HH:mm:ss.SSSZ
          examples:
            - 2021-12-09T15:39:48.000+0300
        id:
          type: integer
          description: TrustedBeneficiary id required for update
          format: int64
          examples:
            - 2
        issuer:
          type: string
          description:  issuer code
          length: 5
          examples:
            - 66666
        payee:
          type: string
          description: TrustedBeneficiary payee
          examples:
            - merchantName
        payeeType:
          type: string
          description: TrustedBeneficiary payeeType
          enum:
            - MERCHANT_ID
            - MERCHANT_URL
            - MERCHANT_NAME
            - MERCHANT_MCC
            - MERCHANT_URL_CONTAINS
            - MERCHANT_URL_STARTS
            - MERCHANT_URL_ENDS
          examples:
            - MERCHANT_ID
        payer:
          type: string
          description: TrustedBeneficiary payer
          examples:
            - mck224o28a0k1acp
        payerRef:
          type: string
          description: TrustedBeneficiary payerRef required for create
          examples:
            - 123456
        payerType:
          type: string
          description: TrustedBeneficiary payerType
          enum:
            - TOKEN
            - CARD_HOLDER_ID
          examples:
            - TOKEN
        service:
          type: string
          description: TrustedBeneficiary  service code
          minLength: 1
          maxLength: 255
          pattern: '^[A-Z\d]{3}_[A-Z\d]{3}(?:_[A-Z\d]+)*$'
          examples:
            - HUB_NRT
        subIssuer:
          type: string
          description: TrustedBeneficiary subIssuer
          lenght: 5
          examples:
            - 66666
        type:
          type: string
          description: TrustedBeneficiary type
          enum:
            - TRUST_LIST_3DSSERVER
            - TRUST_LIST_ACS
            - TRUST_LIST_DS
            - REFUSAL_TRUST_LIST_3DSSERVER
            - REFUSAL_TRUST_LIST_ACS
          examples:
            - TRUST_LIST_ACS
        updatedTime:
          type: string
          description: TrustedBeneficiaryDTO updatedTime
          format: yyyy-MM-dd'T'HH:mm:ss.SSSZ
          examples:
            - 2021-12-09T15:39:48.000+0300
      description: TrustedBeneficiaryDTO resource representation
    TrustedBeneficiaryInternalRequest:
      required:
        - service
        - type
      type: object
      properties:
        issuer:
          type: string
          description: TrustedBeneficiary issuer
          length: 5
          examples:
            - 66666
        pageSize:
          type: integer
          description: TrustedBeneficiaryInternal page size
          format: int32
          examples:
            - 10
        payees:
          type: object
          additionalProperties:
            type: string
            description: "TrustedBeneficiaryInternalRequest payees, key/value - payee\
              \ type/value"
          description: "TrustedBeneficiaryInternalRequest payees, key/value - payee\
            \ type/value"
          examples:
            - {TOKEN: value}
        payers:
          type: object
          additionalProperties:
            type: string
            description: "TrustedBeneficiaryInternalRequest payers, key/value - payer\
              \ type/value"
          description: "TrustedBeneficiaryInternalRequest payers, key/value - payer\
            \ type/value"
          examples:
            - { TOKEN: value }
        service:
          type: string
          description: TrustedBeneficiary service code
          minLength: 1
          maxLength: 255
          pattern: '^[A-Z\d]{3}_[A-Z\d]{3}(?:_[A-Z\d]+)*$'
          examples:
            - HUB_NRT
        start:
          type: integer
          description: TrustedBeneficiaryInternalRequest start page
          format: int32
          examples:
            - 0
        subIssuer:
          type: string
          description: TrustedBeneficiaryInternalRequest subIssuer
          length: 5
          examples:
            - 66666
        type:
          type: string
          description: TrustedBeneficiaryInternalRequest type
          enum:
            - TRUST_LIST_3DSSERVER
            - TRUST_LIST_ACS
            - TRUST_LIST_DS
            - REFUSAL_TRUST_LIST_3DSSERVER
            - REFUSAL_TRUST_LIST_ACS
          examples:
            - TRUST_LIST_3DSSERVER
      description: TrustedBeneficiaryInternalRequest resource representation
    TrustedBeneficiaryExternalRequest:
      required:
        - service
        - type
      type: object
      properties:
        issuer:
          type: string
          description: TrustedBeneficiaryInternalRequest issuer
          length: 5
          examples:
            - 66666
        pageSize:
          type: integer
          description: TrustedBeneficiaryInternalRequest page size
          format: int32
          examples:
            - 50
        payerRef:
          type: string
          description: TrustedBeneficiaryInternalRequest payerRef
          examples:
            - 123456
        payers:
          type: object
          additionalProperties:
            type: string
            description: "TrustedBeneficiaryInternalRequest payers, key/value - payer\
              \ type/value"
          description: "TrustedBeneficiaryInternalRequest payers, key/value - payer\
            \ type/value"
          examples:
            - {TOKEN:value}
        service:
          type: string
          description: TrustedBeneficiaryInternalRequest service code
          minLength: 1
          maxLength: 255
          pattern: '^[A-Z\d]{3}_[A-Z\d]{3}(?:_[A-Z\d]+)*$'
          examples:
            - HUB_NRT
        start:
          type: integer
          description: TrustedBeneficiaryInternalRequest start page
          format: int32
          examples:
            - 0
        subIssuer:
          type: string
          description: TrustedBeneficiaryInternalRequest subIssuer
          length: 5
          examples:
            - 66666
        type:
          type: string
          description: TrustedBeneficiaryInternalRequest type
          enum:
            - TRUST_LIST_3DSSERVER
            - TRUST_LIST_ACS
            - TRUST_LIST_DS
            - REFUSAL_TRUST_LIST_3DSSERVER
            - REFUSAL_TRUST_LIST_ACS
          examples:
            - TRUST_LIST_DS
        withPayee:
          type: string
          description: TrustedBeneficiaryInternalRequest payee
          examples:
            - merchantName
      description: TrustedBeneficiaryInternalRequest resource representation
    #Schemas define the structure of response TrustedBeneficiary
    TrustedBeneficiaryResponseDTO:
      type: object
      properties:
        createdTime:
          type: string
          description: TrustedBeneficiary createdTime
          format: yyyy-MM-dd'T'HH:mm:ss.SSSZ
          examples:
            - 2021-12-09T15:39:48.000+0300
        deletedTime:
          type: string
          description: TrustedBeneficiary deletedTime
          format: yyyy-MM-dd'T'HH:mm:ss.SSSZ
          examples:
            - 2021-12-09T15:39:48.000+0300
        id:
          type: integer
          description: TrustedBeneficiary id required for update
          format: int64
          examples:
            - 2
        issuer:
          type: string
          description: issuer code
          length: 5
          examples:
            - 66666
        payee:
          type: string
          description: TrustedBeneficiary payee
          examples:
            - merchantName
        payeeType:
          type: string
          description: TrustedBeneficiary payeeType
          enum:
            - MERCHANT_ID
            - MERCHANT_URL
            - MERCHANT_NAME
            - MERCHANT_MCC
            - MERCHANT_URL_CONTAINS
            - MERCHANT_URL_STARTS
            - MERCHANT_URL_ENDS
          examples:
            - MERCHANT_ID
        payer:
          type: string
          description: TrustedBeneficiary payer
          examples:
            - mck224o28a0k1acp
        payerRef:
          type: string
          description: TrustedBeneficiary payerRef required for create
          examples:
            - 123456
        payerType:
          type: string
          description: TrustedBeneficiary payerType
          enum:
            - TOKEN
            - CARD_HOLDER_ID
          examples:
            - TOKEN
        service:
          type: string
          description: TrustedBeneficiary  service code
          minLength: 1
          maxLength: 255
          pattern: '^[A-Z\d]{3}_[A-Z\d]{3}(?:_[A-Z\d]+)*$'
          examples:
            - HUB_NRT
        subIssuer:
          type: string
          description: TrustedBeneficiary subIssuer
          lenght: 5
          examples:
            - 66666
        type:
          type: string
          description: TrustedBeneficiary type
          enum:
            - TRUST_LIST_3DSSERVER
            - TRUST_LIST_ACS
            - TRUST_LIST_DS
            - REFUSAL_TRUST_LIST_3DSSERVER
            - REFUSAL_TRUST_LIST_ACS
          examples:
            - TRUST_LIST_ACS
        updatedTime:
          type: string
          description: TrustedBeneficiaryDTO updatedTime
          format: yyyy-MM-dd'T'HH:mm:ss.SSSZ
          examples:
            - 2021-12-09T15:39:48.000+0300
      description: TrustedBeneficiaryDTO resource representation
    RbaAdminResponseOneTB:
      type: object
      properties:
        error:
          type: object
          properties:
            authMeans:
              type: array
              items:
                type: string
            authentId:
              type: string
            blackListStatus:
              type: array
              items:
                type: string
            cardHolderId:
              type: string
            comment:
              type: string
            errorCode:
              type: string
              description: |
                Here is the list of defined functional error codes and their meaning:
                <details>
                  <summary>Click to expand</summary>
                  | Error code | Description |
                  | --- | --- |
                  | 403000000 | The provided Api-Key is invalid or expired | 
                  | 400010005 | Bad parameter |
                  | 400090070 | Bad parameter : Undefined trusted beneficiary |
                  | 400090072 | Bad parameter : Undefined trusted beneficiary Service |
                  | 400090073 | Bad parameter : Undefined trusted beneficiary type |
                  | 400090074 | Bad parameter : Undefined trusted beneficiary payer |
                  | 400090075 | Bad parameter : Undefined trusted beneficiary payer type |
                  | 400090076 | Bad parameter : Undefined trusted beneficiary payee |
                  | 400090077 | Bad parameter : Undefined trusted beneficiary payee type |
                  | 400090068 | Bad parameter : Undefined trusted beneficiary payer ref |
                </details>
              examples:
                - 403000000
            extRbaDecision:
              type: string
            extRbaLevel:
              type: integer
              format: int32
            externalWSResponse:
              type: string
            id:
              type: string
            issuerCode:
              type: string
            issuerRbaDecision:
              type: string
            issuerRbaLevel:
              type: integer
              format: int32
            language:
              type: string
            message:
              type: string
              examples:
                - The provided Api-Key is invalid or expired
            principal:
              $ref: '#/components/schemas/ErrorPrincipal'
            rbaDecision:
              type: string
            rbaLevel:
              type: string
            rbaReasonType:
              type: string
            site:
              type: string
            subIssuerCode:
              type: string
            tokenPan:
              type: string
            urlSite:
              type: string
        success:
          $ref: '#/components/schemas/TrustedBeneficiaryResponseDTO'
    RbaAdminResponseListTB:
      type: object
      properties:
        error:
          type: object
          properties:
            authMeans:
              type: array
              items:
                type: string
            authentId:
              type: string
            blackListStatus:
              type: array
              items:
                type: string
            cardHolderId:
              type: string
            comment:
              type: string
            errorCode:
              type: string
              description: |
                Here is the list of defined functional error codes and their meaning:
                <details>
                  <summary>Click to expand</summary>
                  | Error code | Description |
                  | --- | --- |
                  | 403000000 | The provided Api-Key is invalid or expired | 
                  | 403050000 | RBA Whitelist payer or payee values are null| 
                  | 400010005 | Bad parameter : service |
                  | 400090081 | Bad parameter : Invalid Trusted beneficiary request |
                  | 400090073 | Bad parameter : Undefined trusted beneficiary type |
                  | 520000000 | Unexpected error |
                </details>
              examples:
                - 403000000
            extRbaDecision:
              type: string
            extRbaLevel:
              type: integer
              format: int32
            externalWSResponse:
              type: string
            id:
              type: string
            issuerCode:
              type: string
            issuerRbaDecision:
              type: string
            issuerRbaLevel:
              type: integer
              format: int32
            language:
              type: string
            message:
              type: string
              examples:
                - The provided Api-Key is invalid or expired
            principal:
              $ref: '#/components/schemas/ErrorPrincipal'
            rbaDecision:
              type: string
            rbaLevel:
              type: string
            rbaReasonType:
              type: string
            site:
              type: string
            subIssuerCode:
              type: string
            tokenPan:
              type: string
            urlSite:
              type: string
        success:
          type: array
          items:
            $ref: '#/components/schemas/TrustedBeneficiaryResponseDTO'
    TrustedBeneficiaryExternalResponse:
      type: object
      properties:
        totalCount:
          type: integer
          format: int32
          examples:
            - 6
        trustedBeneficiaries:
          type: array
          items:
            $ref: '#/components/schemas/TrustedBeneficiaryResponseDTO'
    RbaAdminExternalResponseListTB:
      type: object
      properties:
        error:
          type: object
          properties:
            authMeans:
              type: array
              items:
                type: string
            authentId:
              type: string
            blackListStatus:
              type: array
              items:
                type: string
            cardHolderId:
              type: string
            comment:
              type: string
            errorCode:
              type: string
              description: |
                Here is the list of defined functional error codes and their meaning:
                <details>
                  <summary>Click to expand</summary>
                  | Error code | Description |
                  | --- | --- |
                  | 403000000 | The provided Api-Key is invalid or expired | 
                  | 400010005 | Bad parameter |
                  | 520000000 | Unexpected error |
                </details>
              examples:
                - 403000000
            extRbaDecision:
              type: string
            extRbaLevel:
              type: integer
              format: int32
            externalWSResponse:
              type: string
            id:
              type: string
            issuerCode:
              type: string
            issuerRbaDecision:
              type: string
            issuerRbaLevel:
              type: integer
              format: int32
            language:
              type: string
            message:
              type: string
              examples:
                - The provided Api-Key is invalid or expired
            principal:
              $ref: '#/components/schemas/ErrorPrincipal'
            rbaDecision:
              type: string
            rbaLevel:
              type: string
            rbaReasonType:
              type: string
            site:
              type: string
            subIssuerCode:
              type: string
            tokenPan:
              type: string
            urlSite:
              type: string
        success:
          $ref: '#/components/schemas/TrustedBeneficiaryExternalResponse'
    # Schemas define the structure of request RuleSet
    UpdateAllRulesOrdinalsRequest:
      required:
        - ruleIds
        - rulesetId
      type: object
      properties:
        ruleIds:
          type: array
          description: rule ids
          items:
            type: integer
            description: UpdateAllRulesOrdinalsRequest rule ids
            format: int64
          examples:
            - [1,2]
        rulesetId:
          type: integer
          description:  ruleset id
          format: int64
          examples:
            - 5
      description: UpdateAllRulesOrdinalsRequest resource representation
    UpdateRuleOrdinalRequest:
      required:
        - ruleId
        - type
      type: object
      properties:
        ruleId:
          type: integer
          description:  rule id
          format: int64
          examples:
            - 1
        type:
          type: string
          description: RuleOrdinal type
          enum:
            - UP
            - DOWN
          examples:
            - UP
      description: UpdateRuleOrdinalRequest resource representation
    ConditionDTO:
      required:
        - id
        - name
        - ruleId
      type: object
      properties:
        createdTime:
          type: string
          description: Entity creation time
          format: yyyy-MM-dd'T'HH:mm:ss.SSSZ
          examples:
            - 2021-12-09T15:39:48.000+0300
        deletedTime:
          type: string
          description: Entity deletion time
          format: yyyy-MM-dd'T'HH:mm:ss.SSSZ
          examples:
            - 2021-12-09T15:39:48.000+0300
        id:
          type: integer
          description: Entity id
          format: int64
          examples:
            - 2
        name:
          type: string
          description: Condition  name
          examples:
            - C0_3RI_DECOUPLED
        operandDTOs:
          type: array
          description: list of operand dto elements
          items:
            $ref: '#/components/schemas/OperandDTO'
        ruleId:
          type: integer
          description: rule ID
          format: int64
          examples:
            - 2
        updatedTime:
          type: string
          description: Entity last update time
          format: yyyy-MM-dd'T'HH:mm:ss.SSSZ
          examples:
            - 2021-12-09T15:39:48.000+0300
      description: ConditionDTO resource representation
    RuleDTO:
      required:
        - authType
        - id
        - name
        - ordinal
        - reasonType
        - ruleSetId
      type: object
      properties:
        active:
          type: boolean
          description: Rule active
          examples:
            - true
        authType:
          type: string
          description: authentication type
          enum:
            - FRICTIONLESS
            - SCA
            - DECLINE
            - EXTRBADECISION
          examples:
            - FRICTIONLESS
        conditionDTOs:
          type: array
          description: list of condition dto elements
          items:
            $ref: '#/components/schemas/ConditionDTO'
        createdTime:
          type: string
          description: Entity creation time
          format: yyyy-MM-dd'T'HH:mm:ss.SSSZ
          examples:
            - 2021-12-09T15:39:48.000+0300
        deletedTime:
          type: string
          description: Entity deletion time
          format: yyyy-MM-dd'T'HH:mm:ss.SSSZ
          examples:
            - 2021-12-09T15:39:48.000+0300
        id:
          type: integer
          description: Entity id
          format: int64
          examples:
            - 1
        name:
          type: string
          description: Rule name
          examples:
            - TRN_3RI_DECOUPLED
        ordinal:
          type: integer
          description: Rule ordinal
          format: int32
          examples:
            - 9
        reasonType:
          type: string
          description: Rule reason type
          enum:
            - LOW_VALUE
            - LOW_SCORE
            - RECURRING
            - ACQ_EXEMPTION
            - SEC_CORPORATE
            - INSTALMENT
            - THREE_RI_INSTALMENT
            - THREE_RI_CARDINFO
            - THREE_RI_WHITELIST
            - THREE_RI_RECURRING
            - THREE_RI_MOTO
            - FRICTIONLESS_DECISION
            - FRICTIONLESS_MERCHANT_TOP_LEVEL
            - ACQ_EXEMPTION_TRA
            - ACQ_EXEMPTION_DATA_SHARE_ONLY
            - ACQ_EXEMPTION_SCA_ALREADY_DONE
            - FRICTIONLESS_TRUSTED_BENEF_ACS
            - FRICTIONLESS_TRUSTED_BENEF_3DSSERVER
            - FRICTIONLESS_TRUSTED_BENEF_DS
            - THREE_RI_ADD_CARD
            - THREE_RI_PAYMENT
            - THREE_RI_SPLIT_TRN
            - SCA_SPLIT_DELAYED_TRN
            - THREE_RI_ACCOUNT
            - DAF_MUST_APPROVE
            - DAF_ISSUER_DECISION_LOW_RISK
            - FRICTIONLESS_MAINTENANCE_MODE
            - DAF_FIDO_ASSERTION_OK
            - DAF_FIDO_ATTESTATION_OK
            - DAF_FIDO_ATTESTATION_KO
            - DAF_FIDO_ASSERTION_OBO_OK
            - DAF_FIDO_ATTESTATION_OBO_INFO
            - DAF_FIDO_ASSERTION_OBO_VTS_INFO
            - DAF_FIDO_ASSERTION_VTS_OK
            - DAF_FIDO_ASSERTION_VTS_KO
            - HIGH_VALUE
            - HIGH_SCORE
            - MID_VALUE
            - MID_SCORE
            - MAX_FRICTIONLESS
            - NO_RULES
            - RBA_FALLBACK
            - FIRST_RECURRING
            - FIRST_SCA
            - ACQ_SCA_REQ
            - THREE_RI_DECOUPLED
            - FIRST_INSTALMENT
            - SCA_DECISION
            - SCA_MERCHANT_TOP_LEVEL
            - ID_V_SCA_REQ
            - SCA_TRUSTED_BENEF_3DSSERVER
            - SCA_TRUSTED_BENEF_DS
            - SCA_TRUSTED_BENEF_ACS
            - THREE_RI_SCA_ADD_CARD
            - DAF_ENROLMENT
            - DAF_FIDO_ENROLLMENT_AUTHORIZED
            - DAF_FIDO_ENROLLMENT_REFUSED
            - HIGH_RISK
            - MEDIUM_RISK
            - SCA_ADD_CARD
            - RISK_FRAUD
            - BIN_ATTACK_FRAUD
            - BLACKLISTED
            - DECLINE_DECISION
            - DECLINE_MERCHANT_TOP_LEVEL
            - THREE_RI_DECLINE_ADD_CARD
            - THREE_RI_NOT_SUPPORTED
            - DAF_ISSUER_DECISION_HIGH_RISK
            - DAF_NOT_SUPPORTED
            - DAF_NON_VDAP
            - DAF_SUSPECTED_FRAUD
            - DECLINE_MAINTENANCE_MODE
            - DAF_STOLEN_CARD
            - PRIOR_TRN_NOT_FOUND
            - INVALID_CARD_NUMBER
            - STOLEN_CARD
            - TRN_NOT_PERMITTED
            - DAF_FIDO_ASSERTION_KO
            - DAF_FIDO_ASSERTION_OBO_KO
            - EXT_RBA
            - LOW_RISK_MERCHANT_CB
            - MC_CARD_TESTING_ATTACK
            - UNKNOWN
          examples:
            - LOW_RISK_MERCHANT_CB
        ruleSetId:
          type: integer
          description: rule set ID
          format: int64
          examples:
            - 2
        updatedTime:
          type: string
          description: Entity last update time
          format: yyyy-MM-dd'T'HH:mm:ss.SSSZ
          examples:
            - 2021-12-09T15:39:48.000+0300
      description: RuleDTO resource representation
    RuleSetDTO:
      required:
        - id
        - service
        - rules
        - version
        - groupId
        - status
      type: object
      properties:
        cardScheme:
          type: string
          description: RuleSet card type
          enum:
            - CB
            - MASTERCARD
            - VISA
            - MAESTRO
            - BANCONTACT
            - JCB
          examples:
            - VISA
        createdTime:
          type: string
          description: Entity creation time
          format: yyyy-MM-dd'T'HH:mm:ss.SSSZ
          examples:
            - 2021-12-09T15:39:48.000+0300
        deletedTime:
          type: string
          description: Entity deletion time
          format: yyyy-MM-dd'T'HH:mm:ss.SSSZ
          examples:
            - 2021-12-09T15:39:48.000+0300
        deviceChannel:
          type: string
          description: RuleSet device channel
          examples:
            - 03
        draftOngoing:
          type: string
          description: RuleSet draft state
          examples:
            - DRAFT_TEST
        groupId:
          type: string
          description: RuleSet group identifier
          examples:
            - 3dbc5e0e-463f-11ed-a4f2-0242ac190003
        id:
          type: integer
          description: identifier, required for update
          format: int64
          examples:
            - 1
        issuer:
          type: string
          description: issuer
          length: 5
          examples:
            - 66666
        label:
          type: string
          description: RuleSet label
          examples:
            - RuleSet 1
        location:
          type: string
          description: RuleSet location
          examples:
            - EEA
        operandValues:
          uniqueItems: true
          type: array
          description: list of operand value dto elements
          items:
            $ref: '#/components/schemas/OperandValueDTO'
        rules:
          type: array
          description: list of rule dto elements
          items:
            $ref: '#/components/schemas/RuleDTO'
        service:
          type: string
          description: service code
          minLength: 1
          maxLength: 255
          pattern: '^[A-Z\d]{3}_[A-Z\d]{3}(?:_[A-Z\d]+)*$'
          examples:
            - HUB_NRT
        status:
          type: string
          description: RuleSet status
          enum:
            - PROD
            - BACKUP
            - DRAFT_EDIT
            - DRAFT_SUBMIT
            - DRAFT_TEST
            - DELETED
            - PRESET
          examples:
            - PRESET
        subIssuer:
          type: string
          description: sub issuer
          length: 5
          examples:
            - 66666
        transactionType:
          type: string
          description: RuleSet transaction type
          enum:
            - ONLINE_BANKING
            - PROT_1X_3DS
            - PROT_2X_3DS
            - XS2A
            - PERSONAL_ID_SYSTEM
          examples:
            - ONLINE_BANKING
        updatedTime:
          type: string
          description: Entity last update time
          format: yyyy-MM-dd'T'HH:mm:ss.SSSZ
          examples:
            - 2021-12-09T15:39:48.000+0300
        version:
          type: string
          description: RuleSet version
          examples:
            - 1.0.0
      description: RuleSetDTO resource representation
    RulesetExportDataRequest:
      type: object
      properties:
        checksum:
          type: string
          description: RulesetExportData  checksum
          examples:
            - 120EA8A25E5D487BF68B5F7096440019
        ruleSet:
          $ref: '#/components/schemas/RuleSetDTO'
      description: RulesetExportData resource representation
    RuleSetStateRequestDTO:
      required:
        - id
        - service
        - status
      type: object
      properties:
        comment:
          type: string
          description: RuleSetStateRequestDTO comment
          examples:
            - comment
        deleteProd:
          type: boolean
          description: RuleSetStateRequestDTO deleteProd
          examples:
            - false
        id:
          type: integer
          description: RuleSetStateRequestDTO id
          format: int64
          examples:
            - 2
        service:
          type: string
          description: RuleSetStateRequestDTO service code
          minLength: 1
          maxLength: 255
          pattern: '^[A-Z\d]{3}_[A-Z\d]{3}(?:_[A-Z\d]+)*$'
          examples:
            - HUB_NRT
        status:
          type: string
          description: RuleSetStateRequestDTO status
          enum:
            - PROD
            - BACKUP
            - DRAFT_EDIT
            - DRAFT_SUBMIT
            - DRAFT_TEST
            - DELETED
            - PRESET
          examples:
            - PROD
        userID:
          type: string
          description: RuleSetStateRequestDTO userID
          examples:
            - 2
      description: RuleSetStateRequestDTO resource representation
    # Schemas define the structure of response RuleSet
    ConditionResponseDTO:
      type: object
      properties:
        createdTime:
          type: string
          description: Entity creation time
          format: yyyy-MM-dd'T'HH:mm:ss.SSSZ
          examples:
            - 2021-12-09T15:39:48.000+0300
        deletedTime:
          type: string
          description: Entity deletion time
          format: yyyy-MM-dd'T'HH:mm:ss.SSSZ
          examples:
            - 2021-12-09T15:39:48.000+0300
        id:
          type: integer
          description: Entity id
          format: int64
          examples:
            - 2
        name:
          type: string
          description: Condition  name
          examples:
            - C0_3RI_DECOUPLED
        operandDTOs:
          type: array
          description: list of operand dto elements
          items:
            $ref: '#/components/schemas/OperandResponseDTO'
        ruleId:
          type: integer
          description: rule ID
          format: int64
          examples:
            - 2
        updatedTime:
          type: string
          description: Entity last update time
          format: yyyy-MM-dd'T'HH:mm:ss.SSSZ
          examples:
            - 2021-12-09T15:39:48.000+0300
      description: ConditionDTO resource representation
    RuleResponseDTO:
      type: object
      properties:
        active:
          type: boolean
          description: Rule active
          examples:
            - true
        authType:
          type: string
          description: authentication type
          enum:
            - FRICTIONLESS
            - SCA
            - DECLINE
            - EXTRBADECISION
          examples:
            - FRICTIONLESS
        conditionDTOs:
          type: array
          description: list of condition dto elements
          items:
            $ref: '#/components/schemas/ConditionResponseDTO'
        createdTime:
          type: string
          description: Entity creation time
          format: yyyy-MM-dd'T'HH:mm:ss.SSSZ
          examples:
            - 2021-12-09T15:39:48.000+0300
        deletedTime:
          type: string
          description: Entity deletion time
          format: yyyy-MM-dd'T'HH:mm:ss.SSSZ
          examples:
            - 2021-12-09T15:39:48.000+0300
        id:
          type: integer
          description: Entity id
          format: int64
          examples:
            - 1
        name:
          type: string
          description: Rule name
          examples:
            - TRN_3RI_DECOUPLED
        ordinal:
          type: integer
          description: Rule ordinal
          format: int32
          examples:
            - 9
        reasonType:
          type: string
          description: Rule reason type
          enum:
            - LOW_VALUE
            - LOW_SCORE
            - RECURRING
            - ACQ_EXEMPTION
            - SEC_CORPORATE
            - INSTALMENT
            - THREE_RI_INSTALMENT
            - THREE_RI_CARDINFO
            - THREE_RI_WHITELIST
            - THREE_RI_RECURRING
            - THREE_RI_MOTO
            - FRICTIONLESS_DECISION
            - FRICTIONLESS_MERCHANT_TOP_LEVEL
            - ACQ_EXEMPTION_TRA
            - ACQ_EXEMPTION_DATA_SHARE_ONLY
            - ACQ_EXEMPTION_SCA_ALREADY_DONE
            - FRICTIONLESS_TRUSTED_BENEF_ACS
            - FRICTIONLESS_TRUSTED_BENEF_3DSSERVER
            - FRICTIONLESS_TRUSTED_BENEF_DS
            - THREE_RI_ADD_CARD
            - THREE_RI_PAYMENT
            - THREE_RI_SPLIT_TRN
            - SCA_SPLIT_DELAYED_TRN
            - THREE_RI_ACCOUNT
            - DAF_MUST_APPROVE
            - DAF_ISSUER_DECISION_LOW_RISK
            - FRICTIONLESS_MAINTENANCE_MODE
            - DAF_FIDO_ASSERTION_OK
            - DAF_FIDO_ATTESTATION_OK
            - DAF_FIDO_ATTESTATION_KO
            - DAF_FIDO_ASSERTION_OBO_OK
            - DAF_FIDO_ATTESTATION_OBO_INFO
            - DAF_FIDO_ASSERTION_OBO_VTS_INFO
            - DAF_FIDO_ASSERTION_VTS_OK
            - DAF_FIDO_ASSERTION_VTS_KO
            - HIGH_VALUE
            - HIGH_SCORE
            - MID_VALUE
            - MID_SCORE
            - MAX_FRICTIONLESS
            - NO_RULES
            - RBA_FALLBACK
            - FIRST_RECURRING
            - FIRST_SCA
            - ACQ_SCA_REQ
            - THREE_RI_DECOUPLED
            - FIRST_INSTALMENT
            - SCA_DECISION
            - SCA_MERCHANT_TOP_LEVEL
            - ID_V_SCA_REQ
            - SCA_TRUSTED_BENEF_3DSSERVER
            - SCA_TRUSTED_BENEF_DS
            - SCA_TRUSTED_BENEF_ACS
            - THREE_RI_SCA_ADD_CARD
            - DAF_ENROLMENT
            - DAF_FIDO_ENROLLMENT_AUTHORIZED
            - DAF_FIDO_ENROLLMENT_REFUSED
            - HIGH_RISK
            - MEDIUM_RISK
            - SCA_ADD_CARD
            - RISK_FRAUD
            - BIN_ATTACK_FRAUD
            - BLACKLISTED
            - DECLINE_DECISION
            - DECLINE_MERCHANT_TOP_LEVEL
            - THREE_RI_DECLINE_ADD_CARD
            - THREE_RI_NOT_SUPPORTED
            - DAF_ISSUER_DECISION_HIGH_RISK
            - DAF_NOT_SUPPORTED
            - DAF_NON_VDAP
            - DAF_SUSPECTED_FRAUD
            - DECLINE_MAINTENANCE_MODE
            - DAF_STOLEN_CARD
            - PRIOR_TRN_NOT_FOUND
            - INVALID_CARD_NUMBER
            - STOLEN_CARD
            - TRN_NOT_PERMITTED
            - DAF_FIDO_ASSERTION_KO
            - DAF_FIDO_ASSERTION_OBO_KO
            - EXT_RBA
            - LOW_RISK_MERCHANT_CB
            - MC_CARD_TESTING_ATTACK
            - UNKNOWN
          examples:
            - LOW_RISK_MERCHANT_CB
        ruleSetId:
          type: integer
          description: rule set ID
          format: int64
          examples:
            - 2
        updatedTime:
          type: string
          description: Entity last update time
          format: yyyy-MM-dd'T'HH:mm:ss.SSSZ
          examples:
            - 2021-12-09T15:39:48.000+0300
      description: RuleDTO resource representation
    RuleSetResponseDTO:
      type: object
      properties:
        cardScheme:
          type: string
          description: RuleSetDTO card type
          enum:
            - CB
            - MASTERCARD
            - VISA
            - MAESTRO
            - BANCONTACT
            - JCB
          examples:
            - VISA
        createdTime:
          type: string
          description: Entity creation time
          format: yyyy-MM-dd'T'HH:mm:ss.SSSZ
          examples:
            - 2021-12-09T15:39:48.000+0300
        deletedTime:
          type: string
          description: Entity deletion time
          format: yyyy-MM-dd'T'HH:mm:ss.SSSZ
          examples:
            - 2021-12-09T15:39:48.000+0300
        deviceChannel:
          type: string
          description: RuleSet device channel
          examples:
            - 03
        draftOngoing:
          type: string
          description: RuleSet draft state
          examples:
            - DRAFT_EDIT
        groupId:
          type: string
          description: RuleSet group identifier
          examples:
            - f231350b-463d-11ed-a4f2-0242ac190003
        id:
          type: integer
          description: Entity id
          format: int64
          examples:
            - 1
        issuer:
          type: string
          description: issuer code
          length: 5
          examples:
            - 66666
        label:
          type: string
          description: RuleSet label
          examples:
            - RuleSet 9
        location:
          type: string
          description: RuleSet location
          examples:
            - EEA
        operandValues:
          uniqueItems: true
          type: array
          description: list of operand value dto elements
          items:
            $ref: '#/components/schemas/OperandValueResponseDTO'
        rules:
          type: array
          description: list of rule dto elements
          items:
            $ref: '#/components/schemas/RuleResponseDTO'
        service:
          type: string
          description: service code
          minLength: 1
          maxLength: 255
          pattern: '^[A-Z\d]{3}_[A-Z\d]{3}(?:_[A-Z\d]+)*$'
          examples:
            - HUB_NRT
        status:
          type: string
          description: RuleSet status
          enum:
            - PROD
            - BACKUP
            - DRAFT_EDIT
            - DRAFT_SUBMIT
            - DRAFT_TEST
            - DELETED
            - PRESET
          examples:
            - PRESET
        subIssuer:
          type: string
          description: sub issuer
          length: 5
          examples:
            - 66666
        transactionType:
          type: string
          description: transaction type
          enum:
            - ONLINE_BANKING
            - PROT_1X_3DS
            - PROT_2X_3DS
            - XS2A
            - PERSONAL_ID_SYSTEM
          examples:
            - ONLINE_BANKING
        updatedTime:
          type: string
          description: Entity last update time
          format: yyyy-MM-dd'T'HH:mm:ss.SSSZ
          examples:
            - 2021-12-09T15:39:48.000+0300
        version:
          type: string
          description: RuleSet version
          examples:
            - 1.0.0
      description: RuleSetDTO resource representation
    RuleSetListResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            authMeans:
              type: array
              items:
                type: string
            authentId:
              type: string
            blackListStatus:
              type: array
              items:
                type: string
            cardHolderId:
              type: string
            comment:
              type: string
            errorCode:
              type: string
              description: |
                Here is the list of defined functional error codes and their meaning:
                <details>
                  <summary>Click to expand</summary>
                  | Error code | Description |
                  | --- | --- |
                  | 403000000 | The provided Api-Key is invalid or expired | 
                  | 400010005 | Bad parameter |
                  | 400090021 | Bad parameter : Undefined Rule Set Service |
                  | 520000000 | Unexpected error |
                </details>
              examples:
                - 403000000
            extRbaDecision:
              type: string
            extRbaLevel:
              type: integer
              format: int32
            externalWSResponse:
              type: string
            id:
              type: string
            issuerCode:
              type: string
            issuerRbaDecision:
              type: string
            issuerRbaLevel:
              type: integer
              format: int32
            language:
              type: string
            message:
              type: string
              examples:
                - The provided Api-Key is invalid or expired
            principal:
              $ref: '#/components/schemas/ErrorPrincipal'
            rbaDecision:
              type: string
            rbaLevel:
              type: string
            rbaReasonType:
              type: string
            site:
              type: string
            subIssuerCode:
              type: string
            tokenPan:
              type: string
            urlSite:
              type: string
        success:
          type: array
          description: List of RuleSetDTO
          items:
            $ref: '#/components/schemas/RuleSetResponseDTO'
    RuleSetDetailsResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            authMeans:
              type: array
              items:
                type: string
            authentId:
              type: string
            blackListStatus:
              type: array
              items:
                type: string
            cardHolderId:
              type: string
            comment:
              type: string
            errorCode:
              type: string
              description: |
                Here is the list of defined functional error codes and their meaning:
                <details>
                  <summary>Click to expand</summary>
                  | Error code | Description |
                  | --- | --- |
                  | 403000000 | The provided Api-Key is invalid or expired | 
                  | 403040001 | RBA rule set operation forbidden | 
                  | 400100000 | Bad request : Invalid incoming request | 
                  | 400100023 | Bad request : checksum does not match | 
                  | 400100024 | Bad request : no file selected | 
                  | 400010005 | Bad parameter |
                  | 400090010 | Bad parameter : Undefined operand |
                  | 400090012 | Bad parameter : Undefined operand Name |
                  | 400090013 | Bad parameter : Undefined operand Type |
                  | 400090014 | Bad parameter : Operand Type and Name Mismatched |
                  | 400090015 | Bad parameter : Undefined operand Value |
                  | 400090016 | Bad parameter : Undefined condition |
                  | 400090018 | Bad parameter : Undefined condition Name |
                  | 400090020 | Bad parameter : Undefined Rule Set ID |
                  | 400090021 | Bad parameter : Undefined Rule Set Service |
                  | 400090023 | Bad parameter : No rules defined |
                  | 400090024 | Bad parameter : Invalid value for the action code operand |
                  | 400090027 | Bad parameter : Undefined Rule Set |
                  | 400090028 | Bad parameter : Invalid device channel |
                  | 400090030 | Bad parameter : Undefined rule |
                  | 400090032 | Bad parameter : Undefined rule name |
                  | 400090033 | Bad parameter : Undefined rule auth type |
                  | 400090036 | Bad parameter : Rule set already exists |
                  | 400090040 | Bad parameter : Undefined rule reason type |
                  | 400090041 | Bad parameter : Rule reason type is mismatched with auth type |
                  | 400090049 | Bad parameter : Invalid rule set group id |
                  | 400090050 | Bad parameter : Invalid rule set status |
                  | 404060010 | Ruleset has no active rule |
                  | 404060003 | No rule found in default group |
                  | 404060004 | Rule Set not found |
                  | 404060005 | Rule should have at least one condition |
                  | 404060014 | Ruleset version not found. |
                  | 404060015 | Ruleset groupid not found. |
                  | 404060016 | Ruleset status not found. |
                  | 404060017 | Ruleset has no Production stage |
                  | 404060006 | Default rule is missing |
                  | 412010000 | Rule set precondition failed |
                  | 412010001 | A draft already exists for this Rule set |
                  | 412010002 | Stored ruleset and imported ruleset do not match |
                  | 520000006 | Unexpected error while reaching a database resource |
                </details>
              examples:
                - 403000000
            extRbaDecision:
              type: string
            extRbaLevel:
              type: integer
              format: int32
            externalWSResponse:
              type: string
            id:
              type: string
            issuerCode:
              type: string
            issuerRbaDecision:
              type: string
            issuerRbaLevel:
              type: integer
              format: int32
            language:
              type: string
            message:
              type: string
              examples:
                - The provided Api-Key is invalid or expired
            principal:
              $ref: '#/components/schemas/ErrorPrincipal'
            rbaDecision:
              type: string
            rbaLevel:
              type: string
            rbaReasonType:
              type: string
            site:
              type: string
            subIssuerCode:
              type: string
            tokenPan:
              type: string
            urlSite:
              type: string
        success:
          $ref: '#/components/schemas/RuleSetResponseDTO'
    RulesetExportData:
      type: object
      properties:
        checksum:
          type: string
          description: RulesetExportData  checksum
          examples:
            - 120EA8A25E5D487BF68B5F7096440019
        ruleSet:
          $ref: '#/components/schemas/RuleSetResponseDTO'
      description: RulesetExportData resource representation
    RuleSetExportDataResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            authMeans:
              type: array
              items:
                type: string
            authentId:
              type: string
            blackListStatus:
              type: array
              items:
                type: string
            cardHolderId:
              type: string
            comment:
              type: string
            errorCode:
              type: string
              description: |
                Here is the list of defined functional error codes and their meaning:
                <details>
                  <summary>Click to expand</summary>
                  | Error code | Description |
                  | --- | --- |
                  | 403000000 | The provided Api-Key is invalid or expired | 
                  | 403040001 | RBA rule set operation forbidden. | 
                  | 400010005 | Bad parameter |
                  | 400090020 | Bad parameter : Undefined Rule Set ID |
                  | 404060004 | Rule Set not found |
                  | 520000005 | Unexpected JSON deserialization error |
                </details>
              examples:
                - 403000000
            extRbaDecision:
              type: string
            extRbaLevel:
              type: integer
              format: int32
            externalWSResponse:
              type: string
            id:
              type: string
            issuerCode:
              type: string
            issuerRbaDecision:
              type: string
            issuerRbaLevel:
              type: integer
              format: int32
            language:
              type: string
            message:
              type: string
              examples:
                - The provided Api-Key is invalid or expired
            principal:
              $ref: '#/components/schemas/ErrorPrincipal'
            rbaDecision:
              type: string
            rbaLevel:
              type: string
            rbaReasonType:
              type: string
            site:
              type: string
            subIssuerCode:
              type: string
            tokenPan:
              type: string
            urlSite:
              type: string
        success:
          $ref: '#/components/schemas/RulesetExportData'
    # Schemas define the structure of response general dto`s
    ServiceResponseDTO:
      type: object
      properties:
        id:
          type: integer
          description: ServiceDTO identifier
          format: int64
          examples:
            - 2
        label:
          type: string
          description: ServiceDTO label
          examples:
            - HUB_BLC
      description: ServiceDTO resource representation
    AuthenticationHUBError:
      type: object
      properties:
        authMeans:
          type: array
          items:
            type: string
        authentId:
          type: string
        blackListStatus:
          type: array
          items:
            type: string
        cardHolderId:
          type: string
        comment:
          type: string
        errorCode:
          type: string
          examples:
            - 403000000
        extRbaDecision:
          type: string
        extRbaLevel:
          type: integer
          format: int32
        externalWSResponse:
          type: string
        id:
          type: string
        issuerCode:
          type: string
        issuerRbaDecision:
          type: string
        issuerRbaLevel:
          type: integer
          format: int32
        language:
          type: string
        message:
          type: string
          examples:
            - The provided Api-Key is invalid or expired
        principal:
          $ref: '#/components/schemas/ErrorPrincipal'
        rbaDecision:
          type: string
        rbaLevel:
          type: string
        rbaReasonType:
          type: string
        site:
          type: string
        subIssuerCode:
          type: string
        tokenPan:
          type: string
        urlSite:
          type: string
    ErrorPrincipal:
      type: object
      properties:
        type:
          type: string
        value:
          type: string
    # Schemas define the structure of request general dto`s
    ServiceDTO:
      required:
        - id
        - label
      type: object
      properties:
        id:
          type: integer
          description: ServiceDTO identifier
          format: int64
          examples:
            - 2
        label:
          type: string
          description: ServiceDTO label
          minLength: 1
          maxLength: 255
          pattern: '^[A-Z\d]{3}_[A-Z\d]{3}(?:_[A-Z\d]+)*$'
          examples:
            - HUB_BLC
      description: ServiceDTO resource representation
    RbaAdminResponseListBL:
      type: object
      properties:
        error:
          type: object
          properties:
            authMeans:
              type: array
              items:
                type: string
            authentId:
              type: string
            blackListStatus:
              type: array
              items:
                type: string
            cardHolderId:
              type: string
            comment:
              type: string
            errorCode:
              type: string
              description: |
                Here is the list of defined functional error codes and their meaning:
                <details>
                  <summary>Click to expand</summary>
                  | Error code | Description |
                  | --- | --- |
                  | 403000000 | The provided Api-Key is invalid or expired | 
                  | 400010005 | Bad parameter |
                  | 400050002 | Bad parameter : Blacklist Type |
                  | 400050005 | Bad parameter : Service Code |
                  | 404000000 | Service not found |
                </details>
              examples:
                - 403000000
            extRbaDecision:
              type: string
            extRbaLevel:
              type: integer
              format: int32
            externalWSResponse:
              type: string
            id:
              type: string
            issuerCode:
              type: string
            issuerRbaDecision:
              type: string
            issuerRbaLevel:
              type: integer
              format: int32
            language:
              type: string
            message:
              type: string
              examples:
                - The provided Api-Key is invalid or expired
            principal:
              $ref: '#/components/schemas/ErrorPrincipal'
            rbaDecision:
              type: string
            rbaLevel:
              type: string
            rbaReasonType:
              type: string
            site:
              type: string
            subIssuerCode:
              type: string
            tokenPan:
              type: string
            urlSite:
              type: string
        numberOfElements:
          type: integer
          format: int32
          examples:
            - 3
        pageNumber:
          type: integer
          format: int32
          examples:
            - 0
        size:
          type: integer
          format: int32
          examples:
            - 200
        success:
          type: array
          items:
            $ref: '#/components/schemas/BlacklistResponseDTO'
        totalElements:
          type: integer
          format: int32
          examples:
            - 3
        totalPages:
          type: integer
          format: int32
          examples:
            - 1

  #Examples
  examples:
    MessageContextErrorExample:
      value:
        principals:
          -[],
        origin: LOCAL,
        originVersion: 25R1Q-P-03-SNAPSHOT,
        originHost: edc9d5c538d7,
        contextTemporary:
          -{},
        requestId: 36388b6f-df09-4005-abda-4d0af277e44a,
        service: HUB_BLC,
        lastEventCode: 400050002,
        privateAPI: false