openapi: "3.1.0"
info:
  title: "APM Web Service Server"
  description: |
    The Risk Base Authentication interfaces exposed by the authentication Hub to the banks.
    
    # Encryption
    
    
    As described in this API, some sensitive fields can be encrypted.
    
    ## Implementation
    
    <details>
      <summary>click to expand</summary>
    
      The encryption is done using the AES algorithm with 256 bits, in CBC or GCM mode.
      The initial vector used is either filled with zeros (in case `inializationVector` field is _null_ or set to `false`), 
      filled with the requestId without the dashes, or with a random value.
      In case of CBC mode, the data is padded using the PKC7 padding.
      The encrypted fields are always exchanged in hexadecimal format.
      The main steps are:
      - IV is set (null, corresponding to the requestId, or random, depending on the configuration);
      - IV is truncated to the algorithm's corresponding IV size (except if configured otherwise);
      - IV's characters are converted from hexadecimal to bytes array;
      - The data is converted to bytes array, using the UTF-8 encoding;
      - The data is encrypted using the IV, the configured key, and the configured algorithm (AES/CBC/PKCS7Padding or AES/GCM/NoPadding);
      - The encrypted data is converted from bytes array to hexadecimal format.
    </details>
    
    ## Sample
    
    <details>
      <summary>click to expand</summary>

    Here are some examples using the following key:
    - **XOR1**: B3EE911BA049ADBEE36B0445C8FC8A2832E7646316F111BCFA3EE062B0379E23
    - **CCV1**: BF36D7
    - **XOR2**: 50A813F0A59FFADDFEFE06904A4E4E42DF30026CE63FECEEAB92043C667FBC0C
    - **CCV2**: DA684A
    - **Clear key**: **E34682EB05D657631D9502D582B2C46AEDD7660FF0CEFD5251ACE45ED648222F**
    - **KCV**: 84A0D9
    
    ### CBC mode
    
    With a _null_ IV:
    - **IV**: 00000000000000000000000000000000
    - **Data to encrypt (clear PAN)**: 4263540111825682
    - **Encrypted data**: 11A18541F9C9E748F62186292BC2DB48BF407F2B049390FBE1037D00AF5FACDA
    
    With a non-_null_ IV:
    - **IV**: 384000008CF011BDB23E10B96E4EF00E
    - **Data to encrypt (clear PAN)**: 4263540111825682
    - **Encrypted data**: 13FA6DE3AA4C939865D5095A14BE22E95E94C9933EA20F32369423270282EC97
    
    ### GCM mode
    
    With a non-_null_ IV:
    - **IV**: 384000008CF011BDB23E10B9 (truncated to 12 bytes / 24 characters)
    - **Data to encrypt (clear PAN)**: 4263540111825682
    - **Encrypted data**: b045162d84b792ee2c89e098d05369defa09bd5eaea899058c8f83da3395f663
    </details>
  version: "25R2.0"
paths:
  /public/searchTrustedBeneficiaries/{requestId}:
    post:
      tags:
        - "trustedBeneficiary"
      operationId: "searchTrustedBeneficiaries"
      summary: "Search trusted beneficiaries"
      description: "Return the list of trusted beneficiaries for the given card."
      parameters:
        - $ref: '#/components/parameters/RequestIdParameter'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TrustedBeneficiarySearchRequest'
      responses:
        "200":
          description: "Nominal response"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TrustedBeneficiarySearchResponse'
        "default":
          $ref: '#/components/responses/ErrorResponse'
  /public/createTrustedBeneficiary/{requestId}:
    post:
      tags:
        - "trustedBeneficiary"
      operationId: "createTrustedBeneficiary"
      summary: "Create a trusted beneficiary"
      description: "Create a trusted beneficiary based on the combination of the provided card and merchant."
      parameters:
        - $ref: '#/components/parameters/RequestIdParameter'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TrustedBeneficiaryCreateRequest'
      responses:
        "200":
          description: "Nominal response"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TrustedBeneficiaryDTO'
        "default":
          $ref: '#/components/responses/ErrorResponse'
  /public/updateTrustedBeneficiary/{requestId}:
    delete:
      tags:
        - "trustedBeneficiary"
      operationId: "deleteTrustedBeneficiary"
      summary: "Delete a trusted beneficiary"
      description: "Delete the trusted beneficiary for the given card (PAN or token PAN)."
      parameters:
        - $ref: '#/components/parameters/RequestIdParameter'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TrustedBeneficiaryDeleteOneRequest'
      responses:
        "200":
          description: "Nominal response"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TrustedBeneficiaryDeleteOneResponse'
        "default":
          $ref: '#/components/responses/ErrorResponse'
  /public/resetTrustedBeneficiaries/{requestId}:
    delete:
      tags:
        - "trustedBeneficiary"
      operationId: "deleteTrustedBeneficiaries"
      summary: "Delete all trusted beneficiaries"
      description: "Delete all trusted beneficiaries for the given card."
      parameters:
        - $ref: '#/components/parameters/RequestIdParameter'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TrustedBeneficiaryDeleteAllRequest'
      responses:
        "200":
          description: "Nominal response"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TrustedBeneficiaryDeleteAllResponse'
        "default":
          $ref: '#/components/responses/ErrorResponse'
  /public/eligible-merchant/search:
    post:
      tags:
        - "eligibleMerchant"
      operationId: "searchEligibleMerchant"
      summary: "Search eligible merchants"
      description: "Return eligible merchants corresponding to the provided criteria, managing pagination."
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SearchEligibleMerchantsRequestDTO'
      responses:
        "200":
          description: "Nominal response"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EligibleMerchantListResponse'
        "default":
          $ref: '#/components/responses/ErrorResponse'
  /public/eligible-merchant/search-by-payee:
    post:
      tags:
        - "eligibleMerchant"
      operationId: "searchEligibleMerchantLike"
      summary: "Search alike eligible merchants"
      description: "Search eligible merchants corresponding to the provided criteria, using a like operation on the payee value,
        and managing pagination."
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SearchEligibleMerchantsByPayeeRequestDTO'
      responses:
        "200":
          description: "Nominal response"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EligibleMerchantListResponse'
        "default":
          $ref: '#/components/responses/ErrorResponse'
  /public/eligible-merchant/{id}/{service}:
    get:
      tags:
        - "eligibleMerchant"
      operationId: "getEligibleMerchant"
      summary: "Get an eligible merchant"
      description: "Returns the eligible merchant with the provided identifier on the provided service. 
        If the eligible merchant is not found, an exception is thrown."
      parameters:
        - name: "id"
          description: "The identifier of the eligible merchant to get."
          in: "path"
          required: true
          schema:
            type: "integer"
            format: "int64"
        - name: "service"
          description: "The service."
          in: "path"
          required: true
          schema:
            type: "string"
      responses:
        "200":
          description: "Nominal response"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EligibleMerchantResponse'
        "default":
          $ref: '#/components/responses/ErrorResponse'
  /public/eligible-merchant/create:
    post:
      tags:
        - "eligibleMerchant"
      operationId: "createEligibleMerchant"
      summary: "Create an eligible merchant"
      description: "Create an eligible merchant.
        The number of eligible merchants per customer (service, or service + issuer) is limited to 500.
        An exception is thrown if there are already 500 active eligible merchants, or if the eligible merchant already exists."
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateEligibleMerchantRequestDTO'
      responses:
        "200":
          description: "Nominal response"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EligibleMerchantResponse'
        "default":
          $ref: '#/components/responses/ErrorResponse'
  /public/eligible-merchant/update:
    put:
      tags:
        - "eligibleMerchant"
      operationId: "updateEligibleMerchant"
      summary: "Update an eligible merchant"
      description: "Update the eligible merchant with the provided identifier on the provided service. 
        If the eligible merchant is not found or already exists with the same
        service/issuer/subIssuer/type/value, an exception is thrown."
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateEligibleMerchantRequestDTO'
      responses:
        "200":
          description: "Nominal response"
        "default":
          $ref: '#/components/responses/ErrorResponse'
  /public/eligible-merchant/delete:
    delete:
      tags:
        - "eligibleMerchant"
      operationId: "deleteEligibleMerchant"
      summary: "Delete an eligible merchant"
      description: "Delete the eligible merchant with the provided identifier on the provided service. 
        If the eligible merchant is not found, an exception is thrown."
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteEligibleMerchantRequestDTO'
      responses:
        "200":
          description: "Nominal response"
        "default":
          $ref: '#/components/responses/ErrorResponse'
  /public/operand/value/{service}:
    put:
      tags:
        - "operand"
      operationId: "updateOperandValue"
      summary: "Update an operand value"
      description: "Update the existing operand value on the provided service with the provided value."
      parameters:
        - name: "service"
          description: "The service."
          in: "path"
          required: true
          schema:
            type: "string"
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateOperandValuesRequest'
      responses:
        "200":
          description: "Nominal response"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateOperandValuesResponse'
        "default":
          $ref: '#/components/responses/ErrorResponse'
components:
  parameters:
    RequestIdParameter:
      name: "requestId"
      in: "path"
      description: "The request identifier."
      required: true
      schema:
        type: "string"
        format: "uuid"
  responses:
    ErrorResponse:
      description: "Error response"
      content:
        application/json:
          schema:
            oneOf:
              - $ref: '#/components/schemas/BusinessErrorResponse'
              - $ref: '#/components/schemas/MessageContext'
  schemas:
    AbstractSearchRequest:
      type: "object"
      properties:
        service:
          description: "The service."
          type: "string"
          minLength: 1
          maxLength: 255
        issuer:
          description: "The issuer code."
          type: "string"
          minLength: 5
          maxLength: 5
        subIssuer:
          description: "The sub-issuer code."
          type: "string"
          minLength: 5
          maxLength: 5
        payeeValue:
          description: "The value of the payee."
          type: "string"
        categories:
          type: "array"
          description: "The list of eligible categories to filter on."
          items:
            description: "An eligible merchant category."
            type: "string"
            enum:
              - "SECURE_CORPORATE"
              - "TRUSTED_BENEFICIARIES_ACS"
              - "TRUSTED_BENEFICIARIES_3DS_SERVER"
              - "DELEGATED_AUTHENTICATION"
              - "TRA"
              - "RISK"
              - "LEVEL_1"
              - "LEVEL_2"
              - "LEVEL_3"
              - "LEVEL_4"
              - "LEVEL_5"
        start:
          description: "The page start index (`0` by default)."
          type: "integer"
        size:
          description: "The page size (`200` by default)."
          type: "integer"
    BusinessErrorResponse:
      description: "Error response in case of business management exception."
      type: "object"
      properties:
        error:
          type: "object"
          properties:
            principal:
              $ref: '#/components/schemas/ErrorPrincipal'
            id:
              description: "The transaction identifier."
              type: "string"
            errorCode:
              $ref: '#/components/schemas/ErrorCode'
            message:
              type: "string"
            comment:
              type: "string"
            authMeans:
              deprecated: true
              type: "array"
              items:
                type: "string"
            authentId:
              deprecated: true
              type: "string"
            blackListStatus:
              deprecated: true
              type: "array"
              items:
                type: "string"
            cardHolderId:
              deprecated: true
              type: "string"
            extRbaDecision:
              deprecated: true
              type: "string"
            extRbaLevel:
              deprecated: true
              type: "integer"
            externalWSResponse:
              deprecated: true
              type: "string"
            issuerCode:
              deprecated: true
              type: "string"
            issuerRbaDecision:
              deprecated: true
              type: "string"
            issuerRbaLevel:
              deprecated: true
              type: "integer"
            language:
              deprecated: true
              type: "string"
            rbaDecision:
              deprecated: true
              type: "string"
            rbaLevel:
              deprecated: true
              type: "string"
            rbaReasonType:
              deprecated: true
              type: "string"
            site:
              deprecated: true
              type: "string"
            subIssuerCode:
              deprecated: true
              type: "string"
            tokenPan:
              deprecated: true
              type: "string"
            urlSite:
              deprecated: true
              type: "string"
    CreateEligibleMerchantRequestDTO:
      description: "The object representing an eligible merchant creation request."
      type: "object"
      required:
        - "service"
        - "payeeType"
        - "payeeValue"
      properties:
        service:
          description: "The service."
          type: "string"
          minLength: 1
          maxLength: 255
        issuer:
          description: "The issuer code."
          type: "string"
          minLength: 5
          maxLength: 5
        subIssuer:
          description: "The sub-issuer code."
          type: "string"
          minLength: 5
          maxLength: 5
        payeeType:
          description: "The type of the payee."
          type: "string"
          enum:
            - "MERCHANT_ID"
            - "MERCHANT_URL"
            - "MERCHANT_NAME"
            - "MERCHANT_MCC"
            - "MERCHANT_URL_CONTAINS"
            - "MERCHANT_URL_STARTS"
            - "MERCHANT_URL_ENDS"
        payeeValue:
          description: "The value of the payee."
          type: "string"
        categories:
          description: "The set of eligible categories."
          type: "array"
          uniqueItems: true
          items:
            description: "An eligible merchant category."
            type: "string"
            enum:
              - "SECURE_CORPORATE"
              - "TRUSTED_BENEFICIARIES_ACS"
              - "TRUSTED_BENEFICIARIES_3DS_SERVER"
              - "DELEGATED_AUTHENTICATION"
              - "TRA"
              - "RISK"
              - "LEVEL_1"
              - "LEVEL_2"
              - "LEVEL_3"
              - "LEVEL_4"
              - "LEVEL_5"
    DeleteEligibleMerchantRequestDTO:
      description: "The object representing an eligible merchant deletion request."
      type: "object"
      required:
        - "id"
        - "service"
      properties:
        id:
          description: "The identifier of the eligible merchant to delete."
          type: "integer"
          format: "int64"
        service:
          description: "The service."
          type: "string"
    EligibleMerchantDTO:
      description: "The object representing an eligible merchant."
      type: "object"
      properties:
        id:
          description: "The eligible merchant identifier."
          type: "integer"
          format: "int64"
        service:
          description: "The service."
          type: "string"
        issuer:
          description: "The issuer code."
          type: "string"
          minLength: 5
          maxLength: 5
        subIssuer:
          description: "The sub-issuer code."
          type: "string"
          minLength: 5
          maxLength: 5
        payeeType:
          description: "The type of the payee."
          type: "string"
          enum:
            - "MERCHANT_ID"
            - "MERCHANT_URL"
            - "MERCHANT_NAME"
            - "MERCHANT_MCC"
            - "MERCHANT_URL_CONTAINS"
            - "MERCHANT_URL_STARTS"
            - "MERCHANT_URL_ENDS"
        payeeValue:
          description: "The value of the payee."
          type: "string"
        categories:
          description: "The list of eligible categories."
          type: "array"
          items:
            description: "An eligible merchant category."
            type: "string"
            enum:
              - "SECURE_CORPORATE"
              - "TRUSTED_BENEFICIARIES_ACS"
              - "TRUSTED_BENEFICIARIES_3DS_SERVER"
              - "DELEGATED_AUTHENTICATION"
              - "TRA"
              - "RISK"
              - "LEVEL_1"
              - "LEVEL_2"
              - "LEVEL_3"
              - "LEVEL_4"
              - "LEVEL_5"
        createdTime:
          description: "The creation time of the eligible merchant."
          type: "string"
          format: "date-time"
        updatedTime:
          description: "The last update time of the eligible merchant."
          type: "string"
          format: "date-time"
    EligibleMerchantListResponse:
      type: "object"
      properties:
        success:
          $ref: '#/components/schemas/SearchEligibleMerchantsResponseDTO'
    EligibleMerchantResponse:
      type: "object"
      properties:
        success:
          $ref: '#/components/schemas/EligibleMerchantDTO'
    ErrorCode:
      description: |
        The 9-digits error code. The 3 first digits match the HTTP status code.
        
        Non-exhaustive list of possible error codes:
        - `400010007`: Bad parameter: principal
        - `400010008`: Bad Parameter: principal Type
        - `400010009`: Bad parameter: principal value
        - `400010010`: Bad parameter: issuer code
        - `400010011`: Bad parameter: subIssuer code
        - `400010018`: Bad parameter: issuer service
        - `400010026`: Bad parameter: key tag
        - `400030003`: Bad parameter: cardinfo.service
        - `400090060`: Bad parameter: undefined trusted beneficiary search request
        - `400090061`: Bad parameter: undefined trusted beneficiary delete request
        - `400090062`: Bad parameter: undefined trusted beneficiary card
        - `400090063`: Bad parameter: undefined trusted beneficiary merchant
        - `400090064`: Bad parameter: undefined trusted beneficiary merchant type
        - `400090065`: Bad parameter: undefined trusted beneficiary merchant value
        - `400090073`: Bad parameter: undefined trusted beneficiary type
        - `400090080`: Bad parameter: trusted beneficiary already exists
        - `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
        - `400090088`: Bad parameter: invalid eligible merchant top level
        - `400090089`: Bad parameter: eligible merchant already exists
        - `400090090`: Bad parameter: eligible merchant limit exceeded
        - `400090095`: Bad parameter: undefined trusted beneficiary status
        - `400100013`: Bad parameter: undefined Token pan
        - `400100022`: Bad parameter: requestId
        - `403000000`: The provided Api-Key is invalid or expired
        - `403900000`: Request blocked by our Firewall Security Policy. Could occurs in case of error on mutual authentication, incorrect URL, incorrect http header, unexpected text, request body is empty. Identifier in the message field is the error id logged in our F5.
        - `500060002`: Error while cipher/decipher
        - `520000000`: Unexpected error
      type: "string"
      minLength: 9
      maxLength: 9
      pattern: "^[0-9]{9}$"
    ErrorPrincipal:
      type: "object"
      properties:
        type:
          type: "string"
        value:
          type: "string"
    InitializationVector:
      description: "The usage of initialization vector (`false` by default).
        Note: be careful of the wrong spelling of the field name."
      type: "string"
      enum:
        - "true"
        - "false"
    KeyTag:
      description: "The tag of the key used to encrypt sensible fields."
      type: "string"
      minLength: 2
      maxLength: 2
      examples:
        - "01"
    MessageContext:
      description: "Error response in case of validation error or technical error."
      type: "object"
      properties:
        errorCode:
          $ref: '#/components/schemas/ErrorCode'
      additionalProperties:
        type: "object"
    RuleSetInfo:
      description: "A rule set information."
      type: "object"
      properties:
        service:
          description: "The service."
          type: "string"
        issuer:
          description: "The issuer code."
          type: "string"
        subIssuer:
          description: "The sub-issuer code."
          type: "string"
        transactionType:
          description: "The transaction type."
          type: "string"
        location:
          description: "The location."
          type: "string"
        cardScheme:
          description: "The card scheme."
          type: "string"
        deviceChanel:
          description: "The device channel."
          type: "string"
    SearchEligibleMerchantsByPayeeRequestDTO:
      allOf:
        - description: "The request object to search alike eligible merchants."
        - $ref: '#/components/schemas/AbstractSearchRequest'
    SearchEligibleMerchantsRequestDTO:
      allOf:
        - description: "The request object to search eligible merchants."
        - type: "object"
        - $ref: '#/components/schemas/AbstractSearchRequest'
        - properties:
            payeeType:
              description: "The type of the payee."
              type: "string"
              enum:
                - "MERCHANT_ID"
                - "MERCHANT_URL"
                - "MERCHANT_NAME"
                - "MERCHANT_MCC"
                - "MERCHANT_URL_CONTAINS"
                - "MERCHANT_URL_STARTS"
                - "MERCHANT_URL_ENDS"
    SearchEligibleMerchantsResponseDTO:
      description: "The response object for eligible merchants search."
      type: "object"
      properties:
        count:
          description: "The number of eligible merchants returned."
          type: "integer"
          format: "int64"
        merchants:
          type: "array"
          description: "The list of eligible merchants corresponding to the provided criteria."
          items:
            $ref: '#/components/schemas/EligibleMerchantDTO'
    TrustedBeneficiaryCardDTO:
      description: "The trusted beneficiary card."
      type: "object"
      required:
        - "principal"
      properties:
        principal:
          $ref: '#/components/schemas/TrustedBeneficiaryCardPrincipalDTO'
    TrustedBeneficiaryCardPrincipalDTO:
      description: "The card principal."
      type: "object"
      required:
        - "type"
        - "value"
      properties:
        type:
          description: "The card principal type."
          type: "string"
          enum:
            - "pan"
            - "tokenPan"
            - "encryptedPan"
            - "cardId"
            - "cardHolderId"
        value:
          description: "The card principal value."
          type: "string"
          minLength: 1
          maxLength: 255
    TrustedBeneficiaryCreateRequest:
      allOf:
        - description: "The request object to create a trusted beneficiary."
        - type: "object"
        - $ref: '#/components/schemas/TrustedBeneficiaryRequest'
        - required:
          - "card"
          - "merchant"
        - properties:
            card:
              $ref: '#/components/schemas/TrustedBeneficiaryCardDTO'
            merchant:
              $ref: '#/components/schemas/TrustedBeneficiaryMerchantRequestDTO'
    TrustedBeneficiaryDeleteAllRequest:
      allOf:
        - description: "The request object to delete all trusted beneficiary for the given card."
        - $ref: '#/components/schemas/TrustedBeneficiaryDeleteRequest'
        - required:
          - "trustedBeneficiaryType"
        - properties:
            trustedBeneficiaryType:
              description: "The type of trusted beneficiary."
              type: "string"
              enum:
                - "ALL"
                - "TRUST_LIST_3DSSERVER"
                - "TRUST_LIST_ACS"
                - "TRUST_LIST_DS"
                - "REFUSAL_TRUST_LIST_3DSSERVER"
                - "REFUSAL_TRUST_LIST_ACS"
    TrustedBeneficiaryDeleteAllResponse:
      description: "The response object for trusted beneficiaries deletion."
      type: "object"
      required:
        - "id"
        - "tokenPan"
      properties:
        id:
          description: "The request identifier."
          type: "string"
        tokenPan:
          description: "The card's token PAN."
          type: "string"
    TrustedBeneficiaryDeleteOneRequest:
      allOf:
        - description: "The request object to delete one trusted beneficiary."
        - $ref: '#/components/schemas/TrustedBeneficiaryDeleteRequest'
        - required:
          - "merchant"
        - properties:
            merchant:
              $ref: '#/components/schemas/TrustedBeneficiaryMerchantRequestDTO'
    TrustedBeneficiaryDeleteOneResponse:
      description: "The response object for a trusted beneficiary deletion."
      type: "object"
      required:
        - "id"
        - "tokenPan"
        - "merchant"
        - "payerRef"
      properties:
        id:
          description: "The request identifier."
          type: "string"
        tokenPan:
          description: "The card's token PAN."
          type: "string"
        payerRef:
          description: "The cardholder identifier."
          type: "string"
          minLength: 1
          maxLength: 64
        merchant:
          $ref: '#/components/schemas/TrustedBeneficiaryMerchantDTO'
    TrustedBeneficiaryDeleteRequest:
      allOf:
        - $ref: '#/components/schemas/TrustedBeneficiaryRequest'
        - required:
          - "card"
        - properties:
            card:
              $ref: '#/components/schemas/TrustedBeneficiaryCardDTO'
    TrustedBeneficiaryDTO:
      description: "The trusted beneficiary representation."
      type: "object"
      required:
        - "service"
        - "type"
        - "payerType"
        - "payer"
        - "payerRef"
        - "payeeType"
        - "payee"
      properties:
        id:
          description: "The trusted beneficiary identifier."
          type: "integer"
          format: "int64"
        service:
          description: "The service."
          type: "string"
        issuer:
          description: "The issuer code."
          type: "string"
          minLength: 5
          maxLength: 5
        subIssuer:
          description: "The sub-issuer code."
          type: "string"
          minLength: 5
          maxLength: 5
        type:
          description: "The type of trusted beneficiary."
          type: "string"
          enum:
            - "TRUST_LIST_3DSSERVER"
            - "TRUST_LIST_ACS"
            - "TRUST_LIST_DS"
            - "REFUSAL_TRUST_LIST_3DSSERVER"
            - "REFUSAL_TRUST_LIST_ACS"
        payerType:
          description: "The payer identifier's type."
          type: "string"
          enum:
            - "TOKEN"
            - "CARD_HOLDER_ID"
        payer:
          description: "The payer's identifier."
          type: "string"
          examples:
            - "mckSTk6NjcwMSAwMYMDAxNQ=="
        payerRef:
          description: "The cardholder identifier."
          type: "string"
          minLength: 1
          maxLength: 64
        payeeType:
          description: "The payee type."
          type: "string"
          enum:
            - "MERCHANT_ID"
            - "MERCHANT_URL"
            - "MERCHANT_NAME"
            - "MERCHANT_MCC"
            - "MERCHANT_URL_CONTAINS"
            - "MERCHANT_URL_STARTS"
            - "MERCHANT_URL_ENDS"
        payee:
          description: "The value of the payee corresponding to the `payeeType` field."
          type: "string"
          examples:
            - "Amazon"
            - "345787989000"
        createdTime:
          description: "The trusted beneficiary created time."
          type: "string"
          format: "date-time"
        updatedTime:
          description: "The trusted beneficiary updated time."
          type: "string"
          format: "date-time"
        deletedTime:
          description: "The trusted beneficiary deleted time."
          type: "string"
          format: "date-time"
    TrustedBeneficiaryMerchantDTO:
      description: "The trusted beneficiary merchant representation."
      type: "object"
      required:
        - "type"
        - "value"
        - "trustedBeneficiaryType"
      properties:
        type:
          description: "The merchant type of the payee."
          type: "string"
          enum:
            - "MERCHANT_ID"
            - "MERCHANT_URL"
            - "MERCHANT_NAME"
            - "MERCHANT_MCC"
            - "MERCHANT_URL_CONTAINS"
            - "MERCHANT_URL_STARTS"
            - "MERCHANT_URL_ENDS"
        value:
          description: "The merchant's value corresponding to the `type` field."
          type: "string"
        trustedBeneficiaryType:
          description: "The type of trusted beneficiary."
          type: "string"
          enum:
            - "TRUST_LIST_3DSSERVER"
            - "TRUST_LIST_ACS"
            - "TRUST_LIST_DS"
            - "REFUSAL_TRUST_LIST_3DSSERVER"
            - "REFUSAL_TRUST_LIST_ACS"
        payeeStatus:
          description: "The trusted beneficiary merchant eligibility."
          type: "boolean"
        createdTime:
          description: "The trusted beneficiary merchant created time."
          type: "string"
          format: "date-time"
        deletedTime:
          description: "The trusted beneficiary merchant deleted time."
          type: "string"
          format: "date-time"
    TrustedBeneficiaryMerchantRequestDTO:
      description: "The trusted beneficiary merchant representation."
      type: "object"
      required:
        - "type"
        - "value"
        - "trustedBeneficiaryType"
      properties:
        type:
          description: "The merchant type of the payee."
          type: "string"
          enum:
            - "MERCHANT_ID"
            - "MERCHANT_URL"
            - "MERCHANT_NAME"
            - "MERCHANT_MCC"
            - "MERCHANT_URL_CONTAINS"
            - "MERCHANT_URL_STARTS"
            - "MERCHANT_URL_ENDS"
        value:
          description: "The merchant's value corresponding to the `type` field."
          type: "string"
        trustedBeneficiaryType:
          description: "The type of trusted beneficiary."
          type: "string"
          enum:
            - "ALL"
            - "TRUST_LIST_3DSSERVER"
            - "TRUST_LIST_ACS"
            - "TRUST_LIST_DS"
            - "REFUSAL_TRUST_LIST_3DSSERVER"
            - "REFUSAL_TRUST_LIST_ACS"
        createdTime:
          description: "The created time of the trusted beneficiary."
          type: "string"
          format: "date-time"
        deletedTime:
          description: "The deleted time of the trusted beneficiary."
          type: "string"
          format: "date-time"
    TrustedBeneficiaryRequest:
      type: "object"
      required:
        - "version"
        - "service"
        - "issuerCode"
        - "subIssuerCode"
      properties:
        version:
          description: "The version."
          type: "string"
        service:
          description: "The service."
          type: "string"
          minLength: 1
          maxLength: 255
        issuerCode:
          description: "The issuer code."
          type: "string"
          minLength: 5
          maxLength: 5
        subIssuerCode:
          description: "The sub-issuer code."
          type: "string"
          minLength: 5
          maxLength: 5
        keyTag:
          $ref: '#/components/schemas/KeyTag'
        inializationVector:
          $ref: '#/components/schemas/InitializationVector'
    TrustedBeneficiarySearchRequest:
      allOf:
        - description: "The request object to get all trusted beneficiaries for the given card."
        - $ref: '#/components/schemas/TrustedBeneficiaryRequest'
        - required:
          - "principal"
        - properties:
            principal:
              $ref: '#/components/schemas/TrustedBeneficiaryCardPrincipalDTO'
            status:
              description: "The status to filter on (`ALL` by default)."
              type: "string"
              enum:
                - "ALL"
                - "ACTIVE"
                - "DELETED"
            trustedBeneficiaryType:
              description: "The trusted beneficiary type to filter on."
              type: "string"
              enum:
                - "ALL"
                - "TRUST_LIST_3DSSERVER"
                - "TRUST_LIST_ACS"
                - "TRUST_LIST_DS"
                - "REFUSAL_TRUST_LIST_3DSSERVER"
                - "REFUSAL_TRUST_LIST_ACS"
    TrustedBeneficiarySearchResponse:
      description: "Trusted beneficiary search response resource representation."
      required:
        - "id"
        - "token"
        - "payerRef"
        - "merchants"
      type: "object"
      properties:
        id:
          description: "The request identifier."
          type: "string"
        token:
          description: "The token PAN."
          type: "string"
        payerRef:
          description: "The cardholder identifier."
          type: "string"
        merchants:
          description: "The list of trusted beneficiary merchants."
          type: "array"
          items:
            $ref: '#/components/schemas/TrustedBeneficiaryMerchantDTO'
    UpdateEligibleMerchantRequestDTO:
      allOf:
        - description: "The object representing an eligible merchant update request."
        - $ref: '#/components/schemas/CreateEligibleMerchantRequestDTO'
        - required:
          - "id"
        - type: "object"
        - properties:
            id:
              description: "The identifier of the eligible merchant to update."
              type: "integer"
              format: "int64"
    UpdateOperandValuesRequest:
      description: "The object representing an operand value update request."
      type: "object"
      required:
        - "label"
        - "value"
      properties:
        issuer:
          description: "The issuer code."
          type: "string"
          minLength: 5
          maxLength: 5
        subIssuer:
          description: "The sub-issuer code."
          type: "string"
          minLength: 5
          maxLength: 5
        label:
          description: "The label of the operand to update."
          type: "string"
          minLength: 1
        value:
          description: "The operand value to set."
          type: "integer"
          format: "int64"
    UpdateOperandValuesResponse:
      description: "The object representing an operand value update response."
      type: "object"
      properties:
        service:
          description: "The service."
          type: "string"
        issuer:
          description: "The issuer code."
          type: "string"
        subIssuer:
          description: "The sub-issuer code."
          type: "string"
        label:
          description: "The label of the operand."
          type: "string"
        value:
          description: "The updated operand value."
          type: "integer"
          format: "int64"
        ruleSetInfos:
          description: "The list of rules updated including the updated operand."
          type: "array"
          items:
            $ref: '#/components/schemas/RuleSetInfo'