openapi: 3.0.1
info:
  title: Referential WS Server
  description: "Rest Referential Public Operations, Version: 2023R3"
  version: "25R1.0"
paths:
  /2023R3-1.0/public/copyCard/{requestId}:
    post:
      tags:
        - card
      description: Copy card from old to new one
      operationId: copyCard
      parameters:
        - name: Api-Key
          in: header
          required: true
          schema:
            type: string
        - name: requestId
          in: path
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PublicCopyCardRequest'
      responses:
        "200":
          description: Default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicSearchCardResponse'
        "400":
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                description: MessageContext
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                description: MessageContext
        "403":
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                description: MessageContext
        "404":
          description: Not Found
          content:
            application/json:
              schema:
                type: object
                description: MessageContext
        "422":
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                type: object
                description: MessageContext
        "500":
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                description: MessageContext
        "503":
          description: Service Unavailable
          content:
            application/json:
              schema:
                type: object
                description: MessageContext
  /2023R3-1.0/public/searchCard/{requestId}:
    post:
      tags:
        - card
      description: Search card
      operationId: searchCard
      parameters:
        - name: Api-Key
          in: header
          required: true
          schema:
            type: string
        - name: requestId
          in: path
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PublicSearchCardRequest'
      responses:
        "200":
          description: Default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicSearchCardResponse'
        "400":
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                description: MessageContext
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                description: MessageContext
        "403":
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                description: MessageContext
        "404":
          description: Not Found
          content:
            application/json:
              schema:
                type: object
                description: MessageContext
        "500":
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                description: MessageContext
        "503":
          description: Service Unavailable
          content:
            application/json:
              schema:
                type: object
                description: MessageContext
        "520":
          description: Unexpected error
          content:
            application/json:
              schema:
                type: object
                description: MessageContext
  /2023R3-1.0/public/searchUserCredentials/{requestId}:
    post:
      tags:
        - credentials
      description: Search user credentials
      operationId: searchUserCredentials
      parameters:
        - name: Api-Key
          in: header
          required: true
          schema:
            type: string
        - name: requestId
          in: path
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PublicSearchUserCredentialsRequest'
      responses:
        "200":
          description: Default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicSearchUserCredentialsResponse'
        "400":
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                description: MessageContext
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                description: MessageContext
        "403":
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                description: MessageContext
        "404":
          description: Not Found
          content:
            application/json:
              schema:
                type: object
                description: MessageContext
        "422":
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                type: object
                description: MessageContext
        "500":
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                description: MessageContext
        "503":
          description: Service Unavailable
          content:
            application/json:
              schema:
                type: object
                description: MessageContext
  /2023R3-1.0/public/searchVirtualCard/{requestId}:
    post:
      tags:
        - virtualCard
      description: Search virtual card
      operationId: readVirtualCard
      parameters:
        - name: Api-Key
          in: header
          required: true
          schema:
            type: string
        - name: requestId
          in: path
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReadVirtualCardRequest'
      responses:
        "200":
          description: Default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReadVirtualCardResponse'
        "400":
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                description: MessageContext
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                description: MessageContext
        "403":
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                description: MessageContext
        "404":
          description: Not Found
          content:
            application/json:
              schema:
                type: object
                description: MessageContext
        "422":
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                type: object
                description: MessageContext
        "500":
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                description: MessageContext
        "503":
          description: Service Unavailable
          content:
            application/json:
              schema:
                type: object
                description: MessageContext
  /2023R3-1.0/public/updateCardWithCredentials/{requestId}:
    post:
      tags:
        - credentials
      description: Update card With Credentials
      operationId: updateCardWithCredentials
      parameters:
        - name: Api-Key
          in: header
          required: true
          schema:
            type: string
        - name: requestId
          in: path
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateCardWithCredentialsRequest'
      responses:
        "200":
          description: Default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateCardWithCredentialsResponse'
        "208":
          description: Already reported
          content:
            application/json:
              schema:
                type: object
                description: MessageContext
        "400":
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                description: MessageContext
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                description: MessageContext
        "403":
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                description: MessageContext
        "404":
          description: Not Found
          content:
            application/json:
              schema:
                type: object
                description: MessageContext
        "422":
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                type: object
                description: MessageContext
        "500":
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                description: MessageContext
        "503":
          description: Service Unavailable
          content:
            application/json:
              schema:
                type: object
                description: MessageContext
  /2023R3-1.0/public/updateUserCredentials/{requestId}:
    post:
      tags:
        - credentials
      description: Update user with credentials
      operationId: updateUserWithCredentials
      parameters:
        - name: Api-Key
          in: header
          required: true
          schema:
            type: string
        - name: requestId
          in: path
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateUserWithCredentialsRequest'
      responses:
        "200":
          description: Default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateUserWithCredentialsResponse'
        "208":
          description: Already reported
          content:
            application/json:
              schema:
                type: object
                description: MessageContext
        "400":
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                description: MessageContext
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                description: MessageContext
        "403":
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                description: MessageContext
        "404":
          description: Not Found
          content:
            application/json:
              schema:
                type: object
                description: MessageContext
        "422":
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                type: object
                description: MessageContext
        "500":
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                description: MessageContext
        "503":
          description: Service Unavailable
          content:
            application/json:
              schema:
                type: object
                description: MessageContext
  /2023R3-1.0/public/virtualCard/{requestId}:
    put:
      tags:
        - virtualCard
      description: Update virtual card
      operationId: updateVirtualCard
      parameters:
        - name: Api-Key
          in: header
          required: true
          schema:
            type: string
        - name: requestId
          in: path
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateVirtualCardRequest'
      responses:
        "200":
          description: Default response
        "400":
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                description: MessageContext
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                description: MessageContext
        "403":
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                description: MessageContext
        "404":
          description: Not Found
          content:
            application/json:
              schema:
                type: object
                description: MessageContext
        "422":
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                type: object
                description: MessageContext
        "500":
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                description: MessageContext
        "503":
          description: Service Unavailable
          content:
            application/json:
              schema:
                type: object
                description: MessageContext
    post:
      tags:
        - virtualCard
      description: Create virtual card
      operationId: createVirtualCard
      parameters:
        - name: Api-Key
          in: header
          required: true
          schema:
            type: string
        - name: requestId
          in: path
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateVirtualCardRequest'
      responses:
        "200":
          description: Default response
        "400":
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                description: MessageContext
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                description: MessageContext
        "403":
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                description: MessageContext
        "404":
          description: Not Found
          content:
            application/json:
              schema:
                type: object
                description: MessageContext
        "422":
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                type: object
                description: MessageContext
        "500":
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                description: MessageContext
        "503":
          description: Service Unavailable
          content:
            application/json:
              schema:
                type: object
                description: MessageContext
components:
  schemas:
    CardDtoUpdateCredentials:
      maxLength: 5
      required:
        - expiry
        - id
        - principal
      type: object
      properties:
        cardHolderId:
          type: string
        cardId:
          type: string
          description: Card identifier. Available in 2021R3 or higher
          format: String of 2 to 36 characters
        expiry:
          $ref: '#/components/schemas/CipherableTypedDataExpiryType'
        id:
          type: string
          description: "Incremental id, from 1 to 5 Always “1” when only one card"
          format: String of 1 character
        label:
          type: string
          description: Card label It can be filled with the ACS profilset to switch
            the card to a dedicated profilset.
          format: String of 1 to 32 characters
        principal:
          $ref: '#/components/schemas/CipherableTypedDataCipherablePrincipalType'
      description: List of the cards
    CardResponse:
      type: object
      properties:
        cardHolderId:
          type: string
        cardId:
          type: string
        id:
          type: string
        language:
          type: string
        tokenPan:
          type: string
    CipherableTypedDataCipherablePrincipalType:
      type: object
      properties:
        keyTag:
          type: string
        type:
          type: string
          description: Ciphered principal
          enum:
            - CARD_HOLDER_ID
            - PAN
            - ENCRYPTED_PAN
            - TOKEN_PAN
            - CARD_ID
        value:
          type: string
      description: Ciphered data
    CipherableTypedDataCredentialsType:
      type: object
      properties:
        keyTag:
          type: string
        type:
          type: string
          enum:
            - CREDENTIALS
            - ENCRYPTED_CREDENTIALS
            - PLAIN
            - ENCRYPTED
        value:
          type: string
      description: Ciphered data
    CipherableTypedDataExpiryType:
      type: object
      properties:
        keyTag:
          type: string
        type:
          type: string
          description: Ciphered expiry date
          enum:
            - EXPIRY
            - ENCRYPTED_EXPIRY
            - PLAIN
            - ENCRYPTED
        value:
          type: string
      description: Ciphered data
    CreateVirtualCardRequest:
      required:
        - issuerCode
        - principal
        - service
        - subIssuerCode
        - vDeletedTime
        - vExpiryDate
        - vPrincipal
      type: object
      properties:
        cardHolderId:
          maxLength: 36
          minLength: 2
          type: string
          description: Cardholder ID
        inializationVector:
          type: string
          description: "Usage of initialization vector: “false” (default value) “\
            true”"
        issuerCode:
          maxLength: 5
          minLength: 5
          type: string
          description: Issuer code
          format: The issuer code is mandatory on all Admin WS endpoints except for
            searchCards() and getCardDetails(CardDetailRequest)
        principal:
          $ref: '#/components/schemas/CipherableTypedDataCipherablePrincipalType'
        requestId:
          type: string
          description: Request ID
          format: String
        service:
          maxLength: 255
          minLength: 1
          type: string
          description: Calling service
        sessionId:
          type: string
          description: Session ID
        subIssuerCode:
          maxLength: 5
          minLength: 5
          type: string
          description: sub issuer code
          format: The sub issuer code is mandatory on all Admin WS endpoints except
            for searchCards() and getCardDetails(CardDetailRequest)
        transactionId:
          type: string
        vDeletedTime:
          type: string
          description: Create Virtual Card request virtualDeletedTime
          format: date-time
        vExpiryDate:
          $ref: '#/components/schemas/CipherableTypedDataExpiryType'
        vPrincipal:
          $ref: '#/components/schemas/CipherableTypedDataCipherablePrincipalType'
      description: Create Virtual Card Request resource representation
    Credential:
      required:
        - type
        - value
      type: object
      properties:
        algorithm:
          type: string
          description: "Credential algorithm, only for PWD means"
        creationDate:
          type: string
          description: "Credential creation date, deserialization ignored"
          format: date-time
        deletedTime:
          type: string
          description: "Credential deleted time in future date, deserialization ignored"
          format: date-time
        modifier:
          type: string
          description: "Credential modifier, deserialization ignored"
        pattern:
          type: string
          description: "Credential pattern, only for DDN means"
        type:
          type: string
          description: Credential type
          format: CredentialType enum
          enum:
            - PWD
            - DDN
            - SSN
            - PAM
            - TOKEN
            - TA
            - EMAIL
            - SMS
            - IVR
            - CCP
            - SVI
            - PHONE
            - OTRC
            - USERCODE
            - OPENID
        updatedTime:
          type: string
          description: "Credential updated time, deserialization ignored"
          format: date-time
        value:
          type: string
          description: Credential value
      description: Credential DTO resource representation
    PublicCopyCardRequest:
      required:
        - issuerCode
        - newCardStatus
        - newDeletedTime
        - newExpiryDate
        - newPan
        - oldPan
        - service
        - subIssuerCode
      type: object
      properties:
        cardHolderId:
          maxLength: 36
          minLength: 2
          type: string
          description: Cardholder ID
        inializationVector:
          type: string
          description: "Usage of initialization vector: “false” (default value) “\
            true”"
        issuerCode:
          maxLength: 5
          minLength: 5
          type: string
          description: Issuer code
          format: The issuer code is mandatory on all Admin WS endpoints except for
            searchCards() and getCardDetails(CardDetailRequest)
        newCardId:
          maxLength: 36
          minLength: 2
          type: string
          description: Copy card request new card Id. Available in v2021R3 or higher.
        newCardStatus:
          type: string
          description: "Copy card request new card status. Status value expected for\
            \ the new card created. Possible values – ACTIVE, INACTIVE, DELETED."
          enum:
            - ACTIVE
            - INACTIVE
            - DELETED
        newDeletedTime:
          type: string
          description: Copy card request new deleted time. Date of end of life in
            ACS of the new card
          format: date-time
        newExpiryDate:
          $ref: '#/components/schemas/CipherableTypedDataExpiryType'
        newPan:
          $ref: '#/components/schemas/CipherableTypedDataCipherablePrincipalType'
        oldCardStatus:
          type: string
          description: "Copy card request old card status. Updated status of the old\
            \ card after the request (if not provided the status will be unchanged).\
            \ Possible values - ACTIVE, INACTIVE, DELETED"
          enum:
            - ACTIVE
            - INACTIVE
            - DELETED
        oldDeletedTime:
          type: string
          description: Copy card request old deleted time. Date of blocking card on
            ACS3.0 (if not provided the date will be unchanged)
          format: date-time
        oldPan:
          $ref: '#/components/schemas/CipherableTypedDataCipherablePrincipalType'
        requestId:
          type: string
          description: Request ID
          format: String
        service:
          maxLength: 255
          minLength: 1
          type: string
          description: Calling service
        sessionId:
          type: string
          description: Session ID
        subIssuerCode:
          maxLength: 5
          minLength: 5
          type: string
          description: sub issuer code
          format: The sub issuer code is mandatory on all Admin WS endpoints except
            for searchCards() and getCardDetails(CardDetailRequest)
        transactionId:
          type: string
      description: PublicCopyCardRequest DTO resource representation
    PublicSearchCardRequest:
      required:
        - expiry
        - issuerCode
        - principal
        - service
        - subIssuerCode
      type: object
      properties:
        cardHolderId:
          maxLength: 36
          minLength: 2
          type: string
          description: Cardholder ID
        expiry:
          $ref: '#/components/schemas/CipherableTypedDataExpiryType'
        inializationVector:
          type: string
          description: "Usage of initialization vector: “false” (default value) “\
            true”"
        issuerCode:
          maxLength: 5
          minLength: 5
          type: string
          description: Issuer code
          format: The issuer code is mandatory on all Admin WS endpoints except for
            searchCards() and getCardDetails(CardDetailRequest)
        principal:
          $ref: '#/components/schemas/CipherableTypedDataCipherablePrincipalType'
        requestId:
          type: string
          description: Request ID
          format: String
        service:
          maxLength: 255
          minLength: 1
          type: string
          description: Calling service
        sessionId:
          type: string
          description: Session ID
        subIssuerCode:
          maxLength: 5
          minLength: 5
          type: string
          description: sub issuer code
          format: The sub issuer code is mandatory on all Admin WS endpoints except
            for searchCards() and getCardDetails(CardDetailRequest)
        transactionId:
          type: string
      description: PublicSearchCardRequest DTO resource representation
    PublicSearchCardResponse:
      type: object
      properties:
        cardHolderId:
          type: string
          description: Search Card Card Holder ID
        cardId:
          type: string
          description: Search Card ID
        createdTime:
          type: string
          description: Search Card Response created time
        credentialList:
          type: array
          description: Search Card credentials (new representation)
          items:
            $ref: '#/components/schemas/Credential'
        data:
          type: string
          description: Search Card data
        deletedTime:
          type: string
          description: Search Card Response deleted time
        expiryDate:
          type: string
          description: Search Card Expiry Date
        firstName:
          type: string
          description: Search Card User First Name
        id:
          type: string
          description: Search Card Response ID
        label:
          type: string
          description: Search Card label
        language:
          type: string
          description: Search Card language
        lastName:
          type: string
          description: Search Card User Last Name
        status:
          type: string
          description: Search Card status
        token:
          type: string
          description: Search Card token
        updatedTime:
          type: string
          description: Search Card Response updated time
      description: PublicSearchCardResponse DTO resource representation
    PublicSearchUserCredentialsRequest:
      required:
        - issuerCode
        - principal
        - service
        - subIssuerCode
      type: object
      properties:
        cardHolderId:
          maxLength: 36
          minLength: 2
          type: string
          description: Cardholder ID
        inializationVector:
          type: string
          description: "Usage of initialization vector: “false” (default value) “\
            true”"
        issuerCode:
          maxLength: 5
          minLength: 5
          type: string
          description: Issuer code
          format: The issuer code is mandatory on all Admin WS endpoints except for
            searchCards() and getCardDetails(CardDetailRequest)
        principal:
          $ref: '#/components/schemas/CipherableTypedDataCipherablePrincipalType'
        requestId:
          type: string
          description: Request ID
          format: String
        service:
          maxLength: 255
          minLength: 1
          type: string
          description: Calling service
        sessionId:
          type: string
          description: Session ID
        subIssuerCode:
          maxLength: 5
          minLength: 5
          type: string
          description: sub issuer code
          format: The sub issuer code is mandatory on all Admin WS endpoints except
            for searchCards() and getCardDetails(CardDetailRequest)
        transactionId:
          type: string
      description: PublicSearchUserCredentialsRequest DTO resource representation
    PublicSearchUserCredentialsResponse:
      type: object
      properties:
        cardHolderId:
          type: string
          description: Search Search User Credentials Response Card Holder ID
        cardResponses:
          type: array
          items:
            $ref: '#/components/schemas/UserCredentialsCardResponse'
        firstName:
          type: string
          description: Search User Credentials Response Card User First Name
        language:
          type: string
          description: Search User Credentials Response Card language
        lastName:
          type: string
          description: Search User Credentials Response Card User Last Name
      description: PublicSearchUserCredentialsResponse DTO resource representation
    ReadVirtualCardRequest:
      required:
        - issuerCode
        - service
        - subIssuerCode
        - vPrincipal
      type: object
      properties:
        cardHolderId:
          maxLength: 36
          minLength: 2
          type: string
          description: Cardholder ID
        inializationVector:
          type: string
          description: "Usage of initialization vector: “false” (default value) “\
            true”"
        issuerCode:
          maxLength: 5
          minLength: 5
          type: string
          description: Issuer code
          format: The issuer code is mandatory on all Admin WS endpoints except for
            searchCards() and getCardDetails(CardDetailRequest)
        requestId:
          type: string
          description: Request ID
          format: String
        service:
          maxLength: 255
          minLength: 1
          type: string
          description: Calling service
        sessionId:
          type: string
          description: Session ID
        subIssuerCode:
          maxLength: 5
          minLength: 5
          type: string
          description: sub issuer code
          format: The sub issuer code is mandatory on all Admin WS endpoints except
            for searchCards() and getCardDetails(CardDetailRequest)
        transactionId:
          type: string
        vPrincipal:
          $ref: '#/components/schemas/CipherableTypedDataCipherablePrincipalType'
      description: Read Virtual Card Request resource representation
    ReadVirtualCardResponse:
      type: object
      properties:
        createdTime:
          type: string
          description: Read Virtual Card response createdTime
        principal:
          $ref: '#/components/schemas/CipherableTypedDataCipherablePrincipalType'
        updatedTime:
          type: string
          description: Read Virtual Card response updatedTime
        vDeletedTime:
          type: string
          description: Read Virtual Card response virtualDeletedTime
        vExpiryDate:
          $ref: '#/components/schemas/CipherableTypedDataExpiryType'
        vPrincipal:
          $ref: '#/components/schemas/CipherableTypedDataCipherablePrincipalType'
      description: ReadVirtualCardResponse resource representation
    UpdateCardWithCredentialsRequest:
      required:
        - cards
        - issuerCode
        - service
        - subIssuerCode
      type: object
      properties:
        cardHolderId:
          maxLength: 36
          minLength: 2
          type: string
          description: Cardholder ID
        cards:
          maxLength: 5
          type: array
          description: List of the cards
          items:
            $ref: '#/components/schemas/CardDtoUpdateCredentials'
        credentialList:
          type: array
          description: "List of credentials of the card, used in 23R2 or higher"
          items:
            $ref: '#/components/schemas/Credential'
        credentials:
          $ref: '#/components/schemas/CipherableTypedDataCredentialsType'
        credentialsUpdateMode:
          type: string
          description: "Specify what to do with AuthenticationData:* UPDATE (default\
            \ value) : if AuthenticationData is provided for an authentication mean,\
            \ replace existing values (if any) with provided one. Other authentication\
            \ means (not provided in file) will be kept. * DELETE_AND_CREATE : Existing\
            \ AuthenticationData (for all authentication means) will be deleted and\
            \ replaced by provided one. When the card doesn’t exists yet, you can\
            \ provide any of the two value (result will be the same)* DELETE : Delete\
            \ all credentials of one type linked to a card. If credential type (mean\
            \ like TA, SMS etc.) that are provided for a given card does not have\
            \ and data associated, it will be skipped. if AuthenticationData is provided\
            \ for an authentication mean, remove all existing values (if any) for\
            \ provided one."
          enum:
            - UPDATE
            - DELETE_AND_CREATE
            - DELETE
        deletedTime:
          type: string
          description: "Available in v2021R1 or higher. Deletion date of the card.\
            \ Once this date is expired, the card is no more usable on 3DS."
          format: date-time
        effectiveUpdateDate:
          type: string
          format: date-time
        expiry:
          $ref: '#/components/schemas/CipherableTypedDataExpiryType'
        firstName:
          maxLength: 64
          minLength: 1
          type: string
          description: available in v2021R1 or higher
        inializationVector:
          type: string
          description: "Usage of initialization vector: “false” (default value) “\
            true”"
        issuerCode:
          maxLength: 5
          minLength: 5
          type: string
          description: Issuer code
          format: The issuer code is mandatory on all Admin WS endpoints except for
            searchCards() and getCardDetails(CardDetailRequest)
        keyTag:
          maxLength: 2
          minLength: 2
          type: string
          description: No more used – a dedicated keyTag must be defined for each
            sensitive data encrypted
          example: "01"
        label:
          type: string
        language:
          maxLength: 2
          minLength: 2
          type: string
          description: "language of the customer, as per the ISO 639-1 standard"
        lastName:
          maxLength: 64
          minLength: 1
          type: string
          description: available in v2021R1 or higher
        principal:
          $ref: '#/components/schemas/CipherableTypedDataCipherablePrincipalType'
        requestId:
          type: string
          description: Request ID
          format: String
        service:
          maxLength: 255
          minLength: 1
          type: string
          description: Calling service
        sessionId:
          type: string
          description: Session ID
        status:
          type: string
          description: "Status of the card: ACTIVE (default value) INACTIVE"
        subIssuerCode:
          maxLength: 5
          minLength: 5
          type: string
          description: sub issuer code
          format: The sub issuer code is mandatory on all Admin WS endpoints except
            for searchCards() and getCardDetails(CardDetailRequest)
        transactionId:
          type: string
      description: UpdateCardWithCredentialsRequest DTO resource representation
    UpdateCardWithCredentialsResponse:
      type: object
      properties:
        cardResponses:
          type: array
          items:
            $ref: '#/components/schemas/CardResponse'
      description: UpdateCardWithCredentialsResponse DTO resource representation
    UpdateUserWithCredentialsRequest:
      required:
        - expiry
        - issuerCode
        - principal
        - service
        - subIssuerCode
      type: object
      properties:
        cardHolderId:
          maxLength: 36
          minLength: 2
          type: string
          description: Cardholder ID
        credentialList:
          type: array
          description: "Credential list of the card, used in 22R3 or higher"
          items:
            $ref: '#/components/schemas/Credential'
        credentials:
          $ref: '#/components/schemas/CipherableTypedDataCredentialsType'
        credentialsUpdateMode:
          type: string
          description: "Specify what to do with AuthenticationData:* UPDATE (default\
            \ value) : if AuthenticationData is provided for an authentication mean,\
            \ replace existing values (if any) with provided one. Other authentication\
            \ means (not provided in file) will be kept. * DELETE_AND_CREATE : Existing\
            \ AuthenticationData (for all authentication means) will be deleted and\
            \ replaced by provided one. When the card doesn’t exists yet, you can\
            \ provide any of the two value (result will be the same)* DELETE : Delete\
            \ all credentials of one type linked to a card. If credential type (mean\
            \ like TA, SMS etc.) that are provided for a given card does not have\
            \ and data associated, it will be skipped. if AuthenticationData is provided\
            \ for an authentication mean, remove all existing values (if any) for\
            \ provided one."
          enum:
            - UPDATE
            - DELETE_AND_CREATE
            - DELETE
        effectiveUpdateDate:
          type: string
          format: date-time
        expiry:
          $ref: '#/components/schemas/CipherableTypedDataExpiryType'
        firstName:
          maxLength: 64
          minLength: 1
          type: string
          description: available in v2021R1 or higher
        inializationVector:
          type: string
          description: "Usage of initialization vector: “false” (default value) “\
            true”"
        issuerCode:
          maxLength: 5
          minLength: 5
          type: string
          description: Issuer code
          format: The issuer code is mandatory on all Admin WS endpoints except for
            searchCards() and getCardDetails(CardDetailRequest)
        keyTag:
          maxLength: 2
          minLength: 2
          type: string
          description: A dedicated keyTag must be defined for each sensitive data
            encrypted - no more used
        label:
          maxLength: 32
          minLength: 1
          type: string
          description: Card label It can be filled with the ACS profilset to switch
            the card to a dedicated profilset.
        language:
          maxLength: 2
          minLength: 2
          type: string
          description: "language of the customer, as per the ISO 639-1 standard"
        lastName:
          maxLength: 64
          minLength: 1
          type: string
          description: available in v2021R1 or higher
        principal:
          $ref: '#/components/schemas/CipherableTypedDataCipherablePrincipalType'
        requestId:
          type: string
          description: Request ID
          format: String
        service:
          maxLength: 255
          minLength: 1
          type: string
          description: Calling service
        sessionId:
          type: string
          description: Session ID
        subIssuerCode:
          maxLength: 5
          minLength: 5
          type: string
          description: sub issuer code
          format: The sub issuer code is mandatory on all Admin WS endpoints except
            for searchCards() and getCardDetails(CardDetailRequest)
        transactionId:
          type: string
      description: UpdateUserWithCredentialsRequest DTO resource representation
    UpdateUserWithCredentialsResponse:
      type: object
      properties:
        cardResponses:
          type: array
          items:
            $ref: '#/components/schemas/CardResponse'
      description: UpdateUserWithCredentialsResponse DTO resource representation
    UpdateVirtualCardRequest:
      required:
        - issuerCode
        - service
        - subIssuerCode
        - vPrincipal
      type: object
      properties:
        cardHolderId:
          maxLength: 36
          minLength: 2
          type: string
          description: Cardholder ID
        inializationVector:
          type: string
          description: "Usage of initialization vector: “false” (default value) “\
            true”"
        issuerCode:
          maxLength: 5
          minLength: 5
          type: string
          description: Issuer code
          format: The issuer code is mandatory on all Admin WS endpoints except for
            searchCards() and getCardDetails(CardDetailRequest)
        requestId:
          type: string
          description: Request ID
          format: String
        service:
          maxLength: 255
          minLength: 1
          type: string
          description: Calling service
        sessionId:
          type: string
          description: Session ID
        subIssuerCode:
          maxLength: 5
          minLength: 5
          type: string
          description: sub issuer code
          format: The sub issuer code is mandatory on all Admin WS endpoints except
            for searchCards() and getCardDetails(CardDetailRequest)
        transactionId:
          type: string
        vDeletedTime:
          type: string
          description: Update Virtual Card request virtualDeletedTime
          format: date-time
        vExpiryDate:
          $ref: '#/components/schemas/CipherableTypedDataExpiryType'
        vPrincipal:
          $ref: '#/components/schemas/CipherableTypedDataCipherablePrincipalType'
      description: Update Virtual Card DTO resource representation
    UserCredentialsCardResponse:
      type: object
      properties:
        credentialList:
          type: array
          items:
            $ref: '#/components/schemas/Credential'
        expiryDate:
          type: string
          description: User Credentials Card status
        label:
          type: string
          description: User Credentials Card status
        status:
          type: string
          description: User Credentials Card status
        tokenPan:
          type: string
          description: User Credentials Card status