openapi: 3.0.1
info:
  title: Token Vault service API
  description: >-
    This is an API reference for the Token Vault service, which provides
    endpoints to create and manage tokens and related cryptographic data.
  version: 1.0.0
servers:
  - url: https://api-services.pxp.io/api/v1
    description: Production environment
  - url: https://api-services.test.pxp.io/api/v1
    description: Sandbox environment
paths:
  /token-vault/{OwnerType}/{OwnerId}/vaults/gateway-tokens:
    post:
      summary: Create gateway token
      description: >-
        Request to create a gateway token, which is used to represent sensitive
        payment data in a secure and tokenised form.
      operationId: create-gateway-token
      parameters:
        - name: OwnerId
          in: path
          description: >-
            The unique identifier of the entity owning the token (e.g.,
            Referrer, Merchant Group, Merchant or Site).
          required: true
          example: MERCHANT-GROUP-1
          style: simple
          schema:
            maxLength: 20
            minLength: 0
            type: string
        - name: OwnerType
          in: path
          description: >-
            The type of entity owning the token (e.g., Referrer, MerchantGroup,
            Merchant or Site).
          required: true
          example: MerchantGroup
          style: simple
          schema:
            enum:
              - Referrer
              - MerchantGroup
              - Merchant
              - Site
            type: string
      requestBody:
        content:
          application/json:
            schema:
              required:
                - primaryAccountNumber
                - expiryMonth
                - expiryYear
                - holderName
              type: object
              properties:
                primaryAccountNumber:
                  description: >-
                    This refers to the unique number assigned to a payment card,
                    such as a credit or debit card. This number typically
                    contains 16 digits, structured in a specific format to
                    indicate the card network, issuing bank, and account number.
                  type: string
                  example: '4111111111111111111'
                expiryMonth:
                  description: This is the expiry month [MM] of the card.
                  type: string
                  example: '03'
                expiryYear:
                  description: This is the expiry year [YYYY] of the card.
                  type: string
                  example: '2025'
                cardVerificationCode:
                  description: >-
                    Represents the Card Verification Code (CVC) associated with
                    the payment card, a security feature for transactions where
                    the card is not physically present. The security code is
                    typically a 3 or 4 digit number found on the card, used to
                    verify that the cardholder is in possession of the card
                    during non-face-to-face transactions.
                  type: string
                  example: '123'
                  nullable: true
                holderName:
                  description: >-
                    The Cardholder Name represents the full name of the
                    individual who owns the payment card. This name is printed
                    on the physical card and is used for verifying the
                    cardholder's identity during transactions. The cardholder
                    name is a vital component for transaction processing,
                    especially in cases of card-not-present transactions like
                    online purchases. It should be treated with confidentiality
                    to safeguard the cardholder's privacy and prevent potential
                    misuse.
                  type: string
                  example: Mr John Doe
              additionalProperties: false
      responses:
        '200':
          description: Successful creation of the gateway token
          content:
            application/json:
              schema:
                type: object
                properties:
                  gatewayTokenId:
                    description: >-
                      The gateway token Id represents a securely stored token
                      that corresponds to a previously saved payment card. This
                      token is generated and maintained by PXP to facilitate
                      recurring transactions or transactions using stored card
                      details, ensuring enhanced security and convenience. When
                      a transaction is performed with a saved card, this token
                      Id should be provided instead of the full card details.
                      This approach enhances security by reducing the exposure
                      of sensitive card information and simplifies the
                      transaction process for returning customers."
                    type: string
                    example: 7f46c09d-d1d1-4f94-9a88-6e8ac32e6341
                    format: uuid
                  maskedPrimaryAccountNumber:
                    description: The masked primary account number (PAN) of the card.
                    type: string
                    example: 123456******7890
                  fundingSource:
                    description: The funding source type (e.g., Credit Card).
                    type: string
                    example: Credit Card
                    nullable: true
                additionalProperties: false
              examples:
                Create Gateway Token Response:
                  value:
                    gatewayTokenId: 7f46c09d-d1d1-4f94-9a88-6e8ac32e6341
                    maskedPrimaryAccountNumber: 123456******7890
                    fundingSource: Credit Card
        '400':
          description: Bad request due to invalid input
          content:
            application/json:
              schema:
                type: object
                properties:
                  correlationId:
                    type: string
                    description: >-
                      A unique identifier generated by PXP, serving as a
                      critical tool for tracing and diagnosing transaction
                      errors. This Id allows for the precise location of
                      transactional issues, facilitating swift investigation and
                      resolution by correlating specific transaction attempts or
                      processes with error logs. Essential for support and
                      operational teams, the correlationId enhances PXP's
                      ability to maintain high-quality service and transaction
                      reliability.
                    example: 81f32b80-2ba0-4430-8ecd-0b559274ba9c
                  details:
                    type: array
                    items: {}
                    description: Additional details about the error.
                  errorCode:
                    type: string
                    description: This is the error code returned for the operation.
                    example: INVALID_REQUEST
                  errorReason:
                    type: string
                    description: This is the error reason returned for the operation.
                    example: The request parameters are invalid.
        '401':
          description: Unauthorised access
          content:
            application/json:
              schema:
                type: object
                properties:
                  correlationId:
                    type: string
                    description: >-
                      A unique identifier generated by PXP, serving as a
                      critical tool for tracing and diagnosing transaction
                      errors. This Id allows for the precise location of
                      transactional issues, facilitating swift investigation and
                      resolution by correlating specific transaction attempts or
                      processes with error logs. Essential for support and
                      operational teams, the correlationId enhances PXP's
                      ability to maintain high-quality service and transaction
                      reliability.
                    example: 81f32b80-2ba0-4430-8ecd-0b559274ba9c
                  details:
                    type: array
                    items: {}
                    description: Additional details about the error.
                  errorCode:
                    type: string
                    description: This is the error code returned for the operation.
                    example: INVALID_REQUEST
                  errorReason:
                    type: string
                    description: This is the error reason returned for the operation.
                    example: The request parameters are invalid.
        '403':
          description: Forbidden access
          content:
            application/json:
              schema:
                type: object
                properties:
                  correlationId:
                    type: string
                    description: >-
                      A unique identifier generated by PXP, serving as a
                      critical tool for tracing and diagnosing transaction
                      errors. This Id allows for the precise location of
                      transactional issues, facilitating swift investigation and
                      resolution by correlating specific transaction attempts or
                      processes with error logs. Essential for support and
                      operational teams, the correlationId enhances PXP's
                      ability to maintain high-quality service and transaction
                      reliability.
                    example: 81f32b80-2ba0-4430-8ecd-0b559274ba9c
                  details:
                    type: array
                    items: {}
                    description: Additional details about the error.
                  errorCode:
                    type: string
                    description: This is the error code returned for the operation.
                    example: INVALID_REQUEST
                  errorReason:
                    type: string
                    description: This is the error reason returned for the operation.
                    example: The request parameters are invalid.
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  correlationId:
                    type: string
                    description: >-
                      A unique identifier generated by PXP, serving as a
                      critical tool for tracing and diagnosing transaction
                      errors. This Id allows for the precise location of
                      transactional issues, facilitating swift investigation and
                      resolution by correlating specific transaction attempts or
                      processes with error logs. Essential for support and
                      operational teams, the correlationId enhances PXP's
                      ability to maintain high-quality service and transaction
                      reliability.
                    example: 81f32b80-2ba0-4430-8ecd-0b559274ba9c
                  details:
                    type: array
                    items: {}
                    description: Additional details about the error.
                  errorCode:
                    type: string
                    description: This is the error code returned for the operation.
                    example: INVALID_REQUEST
                  errorReason:
                    type: string
                    description: This is the error reason returned for the operation.
                    example: The request parameters are invalid.
        '413':
          description: Payload too large
          content:
            application/json:
              schema:
                type: object
                properties:
                  correlationId:
                    type: string
                    description: >-
                      A unique identifier generated by PXP, serving as a
                      critical tool for tracing and diagnosing transaction
                      errors. This Id allows for the precise location of
                      transactional issues, facilitating swift investigation and
                      resolution by correlating specific transaction attempts or
                      processes with error logs. Essential for support and
                      operational teams, the correlationId enhances PXP's
                      ability to maintain high-quality service and transaction
                      reliability.
                    example: 81f32b80-2ba0-4430-8ecd-0b559274ba9c
                  details:
                    type: array
                    items: {}
                    description: Additional details about the error.
                  errorCode:
                    type: string
                    description: This is the error code returned for the operation.
                    example: INVALID_REQUEST
                  errorReason:
                    type: string
                    description: This is the error reason returned for the operation.
                    example: The request parameters are invalid.
        '422':
          description: Unprocessable entity due to semantic errors
          content:
            application/json:
              schema:
                type: object
                properties:
                  correlationId:
                    type: string
                    description: >-
                      A unique identifier generated by PXP, serving as a
                      critical tool for tracing and diagnosing transaction
                      errors. This Id allows for the precise location of
                      transactional issues, facilitating swift investigation and
                      resolution by correlating specific transaction attempts or
                      processes with error logs. Essential for support and
                      operational teams, the correlationId enhances PXP's
                      ability to maintain high-quality service and transaction
                      reliability.
                    example: 81f32b80-2ba0-4430-8ecd-0b559274ba9c
                  details:
                    type: array
                    items: {}
                    description: Additional details about the error.
                  errorCode:
                    type: string
                    description: This is the error code returned for the operation.
                    example: INVALID_REQUEST
                  errorReason:
                    type: string
                    description: This is the error reason returned for the operation.
                    example: The request parameters are invalid.
        '500':
          description: Internal server error.
          content:
            application/json:
              schema:
                type: object
                properties:
                  correlationId:
                    type: string
                    description: >-
                      A unique identifier generated by PXP, serving as a
                      critical tool for tracing and diagnosing transaction
                      errors. This Id allows for the precise location of
                      transactional issues, facilitating swift investigation and
                      resolution by correlating specific transaction attempts or
                      processes with error logs. Essential for support and
                      operational teams, the correlationId enhances PXP's
                      ability to maintain high-quality service and transaction
                      reliability.
                    example: 81f32b80-2ba0-4430-8ecd-0b559274ba9c
                  details:
                    type: array
                    items: {}
                    description: Additional details about the error.
                  errorCode:
                    type: string
                    description: This is the error code returned for the operation.
                    example: INVALID_REQUEST
                  errorReason:
                    type: string
                    description: This is the error reason returned for the operation.
                    example: The request parameters are invalid.
  /token-vault/{OwnerType}/{OwnerId}/vaults/scheme-tokens:
    post:
      summary: Create scheme token
      description: >-
        Request to create a scheme token, representing payment data according to
        scheme rules.
      operationId: create-scheme-token
      parameters:
        - name: OwnerId
          in: path
          description: >-
            The unique identifier of the entity owning the token (e.g.,
            Referrer, Merchant Group, Merchant or Site).
          required: true
          example: MERCHANT-GROUP-1
          style: simple
          schema:
            maxLength: 20
            minLength: 0
            type: string
        - name: OwnerType
          in: path
          description: >-
            The type of entity owning the token (e.g., Referrer, MerchantGroup,
            Merchant or Site).
          required: true
          example: MerchantGroup
          style: simple
          schema:
            enum:
              - Referrer
              - MerchantGroup
              - Merchant
              - Site
            type: string
      requestBody:
        content:
          application/json:
            schema:
              required:
                - primaryAccountNumber
                - expiryMonth
                - expiryYear
                - holderName
              type: object
              properties:
                primaryAccountNumber:
                  description: >-
                    This refers to the unique number assigned to a payment card,
                    such as a credit or debit card. This number typically
                    contains 16 digits, structured in a specific format to
                    indicate the card network, issuing bank, and account number.
                  type: string
                  example: '4111111111111111111'
                expiryMonth:
                  description: This is the expiry month [MM] of the card.
                  type: string
                  example: '03'
                expiryYear:
                  description: This is the expiry year [YYYY] of the card.
                  type: string
                  example: '2025'
                cardVerificationCode:
                  description: >-
                    Represents the Card Verification Code (CVC) associated with
                    the payment card, a security feature for transactions where
                    the card is not physically present. The security code is
                    typically a 3 or 4 digit number found on the card, used to
                    verify that the cardholder is in possession of the card
                    during non-face-to-face transactions.
                  type: string
                  example: '123'
                  nullable: true
                holderName:
                  description: >-
                    The Cardholder Name represents the full name of the
                    individual who owns the payment card. This name is printed
                    on the physical card and is used for verifying the
                    cardholder's identity during transactions. The cardholder
                    name is a vital component for transaction processing,
                    especially in cases of card-not-present transactions like
                    online purchases. It should be treated with confidentiality
                    to safeguard the cardholder's privacy and prevent potential
                    misuse.
                  type: string
                  example: Mr John Doe
              additionalProperties: false
      responses:
        '200':
          description: Successful creation of the scheme token
          content:
            application/json:
              schema:
                type: object
                properties:
                  schemeTokenId:
                    description: >-
                      The unique scheme token Id generated by PXP. It is used as
                      a reference to extract the schemeTokenNumber.
                    type: string
                    format: uuid
                  fundingSource:
                    description: The funding source type (e.g., Bank Account).
                    type: string
                    example: Credit Card
                    nullable: true
                additionalProperties: false
              examples:
                Create Scheme Token Response:
                  value:
                    schemeTokenId: 7d87f401-6977-43a4-8e72-8ff457fc8633
                    fundingSource: Bank Account
        '400':
          description: Bad request due to invalid input
          content:
            application/json:
              schema:
                type: object
                properties:
                  correlationId:
                    type: string
                    description: >-
                      A unique identifier generated by PXP, serving as a
                      critical tool for tracing and diagnosing transaction
                      errors. This Id allows for the precise location of
                      transactional issues, facilitating swift investigation and
                      resolution by correlating specific transaction attempts or
                      processes with error logs. Essential for support and
                      operational teams, the correlationId enhances PXP's
                      ability to maintain high-quality service and transaction
                      reliability.
                    example: 81f32b80-2ba0-4430-8ecd-0b559274ba9c
                  details:
                    type: array
                    items: {}
                    description: Additional details about the error.
                  errorCode:
                    type: string
                    description: This is the error code returned for the operation.
                    example: INVALID_REQUEST
                  errorReason:
                    type: string
                    description: This is the error reason returned for the operation.
                    example: The request parameters are invalid.
        '401':
          description: Unauthorised access
          content:
            application/json:
              schema:
                type: object
                properties:
                  correlationId:
                    type: string
                    description: >-
                      A unique identifier generated by PXP, serving as a
                      critical tool for tracing and diagnosing transaction
                      errors. This Id allows for the precise location of
                      transactional issues, facilitating swift investigation and
                      resolution by correlating specific transaction attempts or
                      processes with error logs. Essential for support and
                      operational teams, the correlationId enhances PXP's
                      ability to maintain high-quality service and transaction
                      reliability.
                    example: 81f32b80-2ba0-4430-8ecd-0b559274ba9c
                  details:
                    type: array
                    items: {}
                    description: Additional details about the error.
                  errorCode:
                    type: string
                    description: This is the error code returned for the operation.
                    example: INVALID_REQUEST
                  errorReason:
                    type: string
                    description: This is the error reason returned for the operation.
                    example: The request parameters are invalid.
        '403':
          description: Forbidden access
          content:
            application/json:
              schema:
                type: object
                properties:
                  correlationId:
                    type: string
                    description: >-
                      A unique identifier generated by PXP, serving as a
                      critical tool for tracing and diagnosing transaction
                      errors. This Id allows for the precise location of
                      transactional issues, facilitating swift investigation and
                      resolution by correlating specific transaction attempts or
                      processes with error logs. Essential for support and
                      operational teams, the correlationId enhances PXP's
                      ability to maintain high-quality service and transaction
                      reliability.
                    example: 81f32b80-2ba0-4430-8ecd-0b559274ba9c
                  details:
                    type: array
                    items: {}
                    description: Additional details about the error.
                  errorCode:
                    type: string
                    description: This is the error code returned for the operation.
                    example: INVALID_REQUEST
                  errorReason:
                    type: string
                    description: This is the error reason returned for the operation.
                    example: The request parameters are invalid.
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  correlationId:
                    type: string
                    description: >-
                      A unique identifier generated by PXP, serving as a
                      critical tool for tracing and diagnosing transaction
                      errors. This Id allows for the precise location of
                      transactional issues, facilitating swift investigation and
                      resolution by correlating specific transaction attempts or
                      processes with error logs. Essential for support and
                      operational teams, the correlationId enhances PXP's
                      ability to maintain high-quality service and transaction
                      reliability.
                    example: 81f32b80-2ba0-4430-8ecd-0b559274ba9c
                  details:
                    type: array
                    items: {}
                    description: Additional details about the error.
                  errorCode:
                    type: string
                    description: This is the error code returned for the operation.
                    example: INVALID_REQUEST
                  errorReason:
                    type: string
                    description: This is the error reason returned for the operation.
                    example: The request parameters are invalid.
        '413':
          description: Payload too large
          content:
            application/json:
              schema:
                type: object
                properties:
                  correlationId:
                    type: string
                    description: >-
                      A unique identifier generated by PXP, serving as a
                      critical tool for tracing and diagnosing transaction
                      errors. This Id allows for the precise location of
                      transactional issues, facilitating swift investigation and
                      resolution by correlating specific transaction attempts or
                      processes with error logs. Essential for support and
                      operational teams, the correlationId enhances PXP's
                      ability to maintain high-quality service and transaction
                      reliability.
                    example: 81f32b80-2ba0-4430-8ecd-0b559274ba9c
                  details:
                    type: array
                    items: {}
                    description: Additional details about the error.
                  errorCode:
                    type: string
                    description: This is the error code returned for the operation.
                    example: INVALID_REQUEST
                  errorReason:
                    type: string
                    description: This is the error reason returned for the operation.
                    example: The request parameters are invalid.
        '422':
          description: Unprocessable entity due to semantic errors
          content:
            application/json:
              schema:
                type: object
                properties:
                  correlationId:
                    type: string
                    description: >-
                      A unique identifier generated by PXP, serving as a
                      critical tool for tracing and diagnosing transaction
                      errors. This Id allows for the precise location of
                      transactional issues, facilitating swift investigation and
                      resolution by correlating specific transaction attempts or
                      processes with error logs. Essential for support and
                      operational teams, the correlationId enhances PXP's
                      ability to maintain high-quality service and transaction
                      reliability.
                    example: 81f32b80-2ba0-4430-8ecd-0b559274ba9c
                  details:
                    type: array
                    items: {}
                    description: Additional details about the error.
                  errorCode:
                    type: string
                    description: This is the error code returned for the operation.
                    example: INVALID_REQUEST
                  errorReason:
                    type: string
                    description: This is the error reason returned for the operation.
                    example: The request parameters are invalid.
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                type: object
                properties:
                  correlationId:
                    type: string
                    description: >-
                      A unique identifier generated by PXP, serving as a
                      critical tool for tracing and diagnosing transaction
                      errors. This Id allows for the precise location of
                      transactional issues, facilitating swift investigation and
                      resolution by correlating specific transaction attempts or
                      processes with error logs. Essential for support and
                      operational teams, the correlationId enhances PXP's
                      ability to maintain high-quality service and transaction
                      reliability.
                    example: 81f32b80-2ba0-4430-8ecd-0b559274ba9c
                  details:
                    type: array
                    items: {}
                    description: Additional details about the error.
                  errorCode:
                    type: string
                    description: This is the error code returned for the operation.
                    example: INVALID_REQUEST
                  errorReason:
                    type: string
                    description: This is the error reason returned for the operation.
                    example: The request parameters are invalid.
  /token-vault/{OwnerType}/{OwnerId}/vaults/scheme-tokens/{SchemeTokenId}:
    get:
      summary: Get scheme token
      description: Request to get a scheme token and its status
      operationId: get-scheme-token
      parameters:
        - name: OwnerId
          in: path
          description: >-
            The unique identifier of the entity owning the token (e.g.,
            Referrer, Merchant Group, Merchant or Site).
          required: true
          example: MERCHANT-GROUP-1
          style: simple
          schema:
            maxLength: 20
            minLength: 0
            type: string
        - name: OwnerType
          in: path
          description: >-
            The type of entity owning the token (e.g., Referrer, MerchantGroup,
            Merchant or Site).
          required: true
          example: MerchantGroup
          style: simple
          schema:
            enum:
              - Referrer
              - MerchantGroup
              - Merchant
              - Site
            type: string
        - name: SchemeTokenId
          in: path
          description: >-
            The unique scheme token ID generated by PXP. It is used as a
            reference to extract the schemeTokenNumber.
          required: true
          example: f47ac10b-58cc-4372-a567-0e02b2c3d479
          style: simple
          schema:
            type: string
      responses:
        '200':
          description: Successful retrieval of the scheme token
          content:
            application/json:
              schema:
                type: object
                properties:
                  schemeTokenId:
                    type: string
                    format: uuid
                    description: >-
                      The unique scheme token ID generated by PXP. It is used as
                      a reference to extract the schemeTokenNumber.
                  schemeTokenProvider:
                    type: string
                    description: The name of the scheme token provider.
                  schemeTokenProcurementState:
                    type: string
                    description: The procurement state of the scheme token.
                  externalSchemeTokenId:
                    type: string
                    nullable: true
                    description: >-
                      A unique identifier token provided by the external payment
                      scheme. This token allows merchants to process payments
                      through different payment service providers (PSPs) or
                      transaction service providers (TSPs). The token
                      facilitates interoperability between different PSPs,
                      enabling merchants to seamlessly integrate with and
                      utilize various payment processing services.
                  status:
                    type: string
                    nullable: true
                    description: The status of the scheme token.
                  paymentAccountReference:
                    type: string
                    nullable: true
                    description: >-
                      The payment account reference associated with the scheme
                      token.
                  schemeTokenNumber:
                    type: string
                    nullable: true
                    description: >-
                      The scheme token number represents a scheme token issued
                      by Visa or Mastercard, used for subsequent transaction
                      processing. This token enhances security and facilitates
                      recurring transactions, providing a secure and efficient
                      alternative to sharing sensitive card details.
                  expiryMonth:
                    type: string
                    nullable: true
                    description: This is the expiry year [YYYY] of the card.
                  expiryYear:
                    type: string
                    nullable: true
                    description: This is the expiry month [MM] of the card.
              examples:
                Get Scheme Token Response:
                  value:
                    schemeTokenId: f47ac10b-58cc-4372-a567-0e02b2c3d479
                    schemeTokenProvider: Visa
                    schemeTokenProcurementState: Completed
                    externalSchemeTokenId: ext-123456789
                    status: Active
                    paymentAccountReference: acc-987654321
                    schemeTokenNumber: '1234567812345678'
                    expiryMonth: '12'
                    expiryYear: '2025'
        '400':
          description: Bad request due to invalid input
          content:
            application/json:
              schema:
                type: object
                properties:
                  correlationId:
                    type: string
                    description: >-
                      A unique identifier generated by PXP, serving as a
                      critical tool for tracing and diagnosing transaction
                      errors. This Id allows for the precise location of
                      transactional issues, facilitating swift investigation and
                      resolution by correlating specific transaction attempts or
                      processes with error logs. Essential for support and
                      operational teams, the correlationId enhances PXP's
                      ability to maintain high-quality service and transaction
                      reliability.
                    example: 81f32b80-2ba0-4430-8ecd-0b559274ba9c
                  details:
                    type: array
                    items: {}
                    description: Additional details about the error.
                  errorCode:
                    type: string
                    description: This is the error code returned for the operation.
                    example: INVALID_REQUEST
                  errorReason:
                    type: string
                    description: This is the error reason returned for the operation.
                    example: The request parameters are invalid.
        '401':
          description: Unauthorised access
          content:
            application/json:
              schema:
                type: object
                properties:
                  correlationId:
                    type: string
                    description: >-
                      A unique identifier generated by PXP, serving as a
                      critical tool for tracing and diagnosing transaction
                      errors. This Id allows for the precise location of
                      transactional issues, facilitating swift investigation and
                      resolution by correlating specific transaction attempts or
                      processes with error logs. Essential for support and
                      operational teams, the correlationId enhances PXP's
                      ability to maintain high-quality service and transaction
                      reliability.
                    example: 81f32b80-2ba0-4430-8ecd-0b559274ba9c
                  details:
                    type: array
                    items: {}
                    description: Additional details about the error.
                  errorCode:
                    type: string
                    description: This is the error code returned for the operation.
                    example: INVALID_REQUEST
                  errorReason:
                    type: string
                    description: This is the error reason returned for the operation.
                    example: The request parameters are invalid.
        '403':
          description: Forbidden access
          content:
            application/json:
              schema:
                type: object
                properties:
                  correlationId:
                    type: string
                    description: >-
                      A unique identifier generated by PXP, serving as a
                      critical tool for tracing and diagnosing transaction
                      errors. This Id allows for the precise location of
                      transactional issues, facilitating swift investigation and
                      resolution by correlating specific transaction attempts or
                      processes with error logs. Essential for support and
                      operational teams, the correlationId enhances PXP's
                      ability to maintain high-quality service and transaction
                      reliability.
                    example: 81f32b80-2ba0-4430-8ecd-0b559274ba9c
                  details:
                    type: array
                    items: {}
                    description: Additional details about the error.
                  errorCode:
                    type: string
                    description: This is the error code returned for the operation.
                    example: INVALID_REQUEST
                  errorReason:
                    type: string
                    description: This is the error reason returned for the operation.
                    example: The request parameters are invalid.
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  correlationId:
                    type: string
                    description: >-
                      A unique identifier generated by PXP, serving as a
                      critical tool for tracing and diagnosing transaction
                      errors. This Id allows for the precise location of
                      transactional issues, facilitating swift investigation and
                      resolution by correlating specific transaction attempts or
                      processes with error logs. Essential for support and
                      operational teams, the correlationId enhances PXP's
                      ability to maintain high-quality service and transaction
                      reliability.
                    example: 81f32b80-2ba0-4430-8ecd-0b559274ba9c
                  details:
                    type: array
                    items: {}
                    description: Additional details about the error.
                  errorCode:
                    type: string
                    description: This is the error code returned for the operation.
                    example: INVALID_REQUEST
                  errorReason:
                    type: string
                    description: This is the error reason returned for the operation.
                    example: The request parameters are invalid.
        '413':
          description: Payload too large
          content:
            application/json:
              schema:
                type: object
                properties:
                  correlationId:
                    type: string
                    description: >-
                      A unique identifier generated by PXP, serving as a
                      critical tool for tracing and diagnosing transaction
                      errors. This Id allows for the precise location of
                      transactional issues, facilitating swift investigation and
                      resolution by correlating specific transaction attempts or
                      processes with error logs. Essential for support and
                      operational teams, the correlationId enhances PXP's
                      ability to maintain high-quality service and transaction
                      reliability.
                    example: 81f32b80-2ba0-4430-8ecd-0b559274ba9c
                  details:
                    type: array
                    items: {}
                    description: Additional details about the error.
                  errorCode:
                    type: string
                    description: This is the error code returned for the operation.
                    example: INVALID_REQUEST
                  errorReason:
                    type: string
                    description: This is the error reason returned for the operation.
                    example: The request parameters are invalid.
        '422':
          description: Unprocessable entity due to semantic errors
          content:
            application/json:
              schema:
                type: object
                properties:
                  correlationId:
                    type: string
                    description: >-
                      A unique identifier generated by PXP, serving as a
                      critical tool for tracing and diagnosing transaction
                      errors. This Id allows for the precise location of
                      transactional issues, facilitating swift investigation and
                      resolution by correlating specific transaction attempts or
                      processes with error logs. Essential for support and
                      operational teams, the correlationId enhances PXP's
                      ability to maintain high-quality service and transaction
                      reliability.
                    example: 81f32b80-2ba0-4430-8ecd-0b559274ba9c
                  details:
                    type: array
                    items: {}
                    description: Additional details about the error.
                  errorCode:
                    type: string
                    description: This is the error code returned for the operation.
                    example: INVALID_REQUEST
                  errorReason:
                    type: string
                    description: This is the error reason returned for the operation.
                    example: The request parameters are invalid.
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                type: object
                properties:
                  correlationId:
                    type: string
                    description: >-
                      A unique identifier generated by PXP, serving as a
                      critical tool for tracing and diagnosing transaction
                      errors. This Id allows for the precise location of
                      transactional issues, facilitating swift investigation and
                      resolution by correlating specific transaction attempts or
                      processes with error logs. Essential for support and
                      operational teams, the correlationId enhances PXP's
                      ability to maintain high-quality service and transaction
                      reliability.
                    example: 81f32b80-2ba0-4430-8ecd-0b559274ba9c
                  details:
                    type: array
                    items: {}
                    description: Additional details about the error.
                  errorCode:
                    type: string
                    description: This is the error code returned for the operation.
                    example: INVALID_REQUEST
                  errorReason:
                    type: string
                    description: This is the error reason returned for the operation.
                    example: The request parameters are invalid.
  /token-vault/{OwnerType}/{OwnerId}/vaults/scheme-tokens/{SchemeTokenId}/cryptograms:
    post:
      summary: Create scheme token cryptogram
      description: >-
        Request to create a scheme token cryptogram, a secure cryptographic
        representation of the token.
      operationId: create-scheme-token-cryptogram
      parameters:
        - name: OwnerId
          in: path
          description: >-
            The unique identifier of the entity owning the token (e.g.,
            Referrer, Merchant Group, Merchant, Site).
          required: true
          example: MERCHANT-GROUP-1
          style: simple
          schema:
            maxLength: 20
            minLength: 0
            type: string
        - name: OwnerType
          in: path
          description: >-
            The type of entity owning the token (e.g., Referrer, MerchantGroup,
            Merchant or Site).
          required: true
          example: MerchantGroup
          style: simple
          schema:
            enum:
              - Referrer
              - MerchantGroup
              - Merchant
              - Site
            type: string
        - name: SchemeTokenId
          in: path
          description: >-
            The unique scheme token Id generated by PXP. It is used as a
            reference to extract the schemeTokenNumber.
          required: true
          style: simple
          example: 7d87f401-6977-43a4-8e72-8ff457fc8633
          schema:
            type: string
      responses:
        '200':
          description: Successful creation of the cryptogram
          content:
            application/json:
              schema:
                type: object
                properties:
                  schemeTokenCryptogram:
                    description: >-
                      A unique cryptogram generated during the tokenisation
                      process, utilized for enhancing the security of
                      transaction processing. This cryptogram acts as a secure
                      and unique identifier, akin to the TAVV, ensuring that
                      each transaction is authenticated and verified without
                      directly using sensitive card details. It plays a crucial
                      role in the secure electronic payment ecosystem,
                      especially in tokenised transactions, by providing an
                      additional layer of security and authentication.
                    type: string
                    example: E1F53135E559C253
                    nullable: true
                  schemeTokenNumber:
                    description: >-
                      The scheme token number represents a scheme token issued
                      by Visa or Mastercard, used for subsequent transaction
                      processing. This token enhances security and facilitates
                      recurring transactions, providing a secure and efficient
                      alternative to sharing sensitive card details.
                    type: string
                    example: '4837261112345678'
                  cryptogramType:
                    description: The type of cryptogram (e.g., 3DSecure).
                    type: string
                    example: 3DSecure
                    nullable: true
                  clientPaymentDataId:
                    description: >-
                      The client payment data identifier associated with the
                      cryptogram.
                    type: string
                    nullable: true
                    example: abc123
                additionalProperties: false
              examples:
                Create Cryptogram Response:
                  value:
                    cryptogramType: 3DSecure
                    clientPaymentDataId: abc123
                    schemeTokenCryptogram: E1F53135E559C253
                    schemeTokenNumber: '4837261112345678'
        '400':
          description: Bad request due to invalid input
          content:
            application/json:
              schema:
                type: object
                properties:
                  correlationId:
                    type: string
                    description: >-
                      A unique identifier generated by PXP, serving as a
                      critical tool for tracing and diagnosing transaction
                      errors. This Id allows for the precise location of
                      transactional issues, facilitating swift investigation and
                      resolution by correlating specific transaction attempts or
                      processes with error logs. Essential for support and
                      operational teams, the correlationId enhances PXP's
                      ability to maintain high-quality service and transaction
                      reliability.
                    example: 81f32b80-2ba0-4430-8ecd-0b559274ba9c
                  details:
                    type: array
                    items: {}
                    description: Additional details about the error.
                  errorCode:
                    type: string
                    description: This is the error code returned for the operation.
                    example: INVALID_REQUEST
                  errorReason:
                    type: string
                    description: This is the error reason returned for the operation.
                    example: The request parameters are invalid.
        '401':
          description: Unauthorised access
          content:
            application/json:
              schema:
                type: object
                properties:
                  correlationId:
                    type: string
                    description: >-
                      A unique identifier generated by PXP, serving as a
                      critical tool for tracing and diagnosing transaction
                      errors. This Id allows for the precise location of
                      transactional issues, facilitating swift investigation and
                      resolution by correlating specific transaction attempts or
                      processes with error logs. Essential for support and
                      operational teams, the correlationId enhances PXP's
                      ability to maintain high-quality service and transaction
                      reliability.
                    example: 81f32b80-2ba0-4430-8ecd-0b559274ba9c
                  details:
                    type: array
                    items: {}
                    description: Additional details about the error.
                  errorCode:
                    type: string
                    description: This is the error code returned for the operation.
                    example: INVALID_REQUEST
                  errorReason:
                    type: string
                    description: This is the error reason returned for the operation.
                    example: The request parameters are invalid.
        '403':
          description: Forbidden access
          content:
            application/json:
              schema:
                type: object
                properties:
                  correlationId:
                    type: string
                    description: >-
                      A unique identifier generated by PXP, serving as a
                      critical tool for tracing and diagnosing transaction
                      errors. This Id allows for the precise location of
                      transactional issues, facilitating swift investigation and
                      resolution by correlating specific transaction attempts or
                      processes with error logs. Essential for support and
                      operational teams, the correlationId enhances PXP's
                      ability to maintain high-quality service and transaction
                      reliability.
                    example: 81f32b80-2ba0-4430-8ecd-0b559274ba9c
                  details:
                    type: array
                    items: {}
                    description: Additional details about the error.
                  errorCode:
                    type: string
                    description: This is the error code returned for the operation.
                    example: INVALID_REQUEST
                  errorReason:
                    type: string
                    description: This is the error reason returned for the operation.
                    example: The request parameters are invalid.
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  correlationId:
                    type: string
                    description: >-
                      A unique identifier generated by PXP, serving as a
                      critical tool for tracing and diagnosing transaction
                      errors. This Id allows for the precise location of
                      transactional issues, facilitating swift investigation and
                      resolution by correlating specific transaction attempts or
                      processes with error logs. Essential for support and
                      operational teams, the correlationId enhances PXP's
                      ability to maintain high-quality service and transaction
                      reliability.
                    example: 81f32b80-2ba0-4430-8ecd-0b559274ba9c
                  details:
                    type: array
                    items: {}
                    description: Additional details about the error.
                  errorCode:
                    type: string
                    description: This is the error code returned for the operation.
                    example: INVALID_REQUEST
                  errorReason:
                    type: string
                    description: This is the error reason returned for the operation.
                    example: The request parameters are invalid.
        '413':
          description: Payload too large
          content:
            application/json:
              schema:
                type: object
                properties:
                  correlationId:
                    type: string
                    description: >-
                      A unique identifier generated by PXP, serving as a
                      critical tool for tracing and diagnosing transaction
                      errors. This Id allows for the precise location of
                      transactional issues, facilitating swift investigation and
                      resolution by correlating specific transaction attempts or
                      processes with error logs. Essential for support and
                      operational teams, the correlationId enhances PXP's
                      ability to maintain high-quality service and transaction
                      reliability.
                    example: 81f32b80-2ba0-4430-8ecd-0b559274ba9c
                  details:
                    type: array
                    items: {}
                    description: Additional details about the error.
                  errorCode:
                    type: string
                    description: This is the error code returned for the operation.
                    example: INVALID_REQUEST
                  errorReason:
                    type: string
                    description: This is the error reason returned for the operation.
                    example: The request parameters are invalid.
        '422':
          description: Unprocessable entity due to semantic errors
          content:
            application/json:
              schema:
                type: object
                properties:
                  correlationId:
                    type: string
                    description: >-
                      A unique identifier generated by PXP, serving as a
                      critical tool for tracing and diagnosing transaction
                      errors. This Id allows for the precise location of
                      transactional issues, facilitating swift investigation and
                      resolution by correlating specific transaction attempts or
                      processes with error logs. Essential for support and
                      operational teams, the correlationId enhances PXP's
                      ability to maintain high-quality service and transaction
                      reliability.
                    example: 81f32b80-2ba0-4430-8ecd-0b559274ba9c
                  details:
                    type: array
                    items: {}
                    description: Additional details about the error.
                  errorCode:
                    type: string
                    description: This is the error code returned for the operation.
                    example: INVALID_REQUEST
                  errorReason:
                    type: string
                    description: This is the error reason returned for the operation.
                    example: The request parameters are invalid.
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                type: object
                properties:
                  correlationId:
                    type: string
                    description: >-
                      A unique identifier generated by PXP, serving as a
                      critical tool for tracing and diagnosing transaction
                      errors. This Id allows for the precise location of
                      transactional issues, facilitating swift investigation and
                      resolution by correlating specific transaction attempts or
                      processes with error logs. Essential for support and
                      operational teams, the correlationId enhances PXP's
                      ability to maintain high-quality service and transaction
                      reliability.
                    example: 81f32b80-2ba0-4430-8ecd-0b559274ba9c
                  details:
                    type: array
                    items: {}
                    description: Additional details about the error.
                  errorCode:
                    type: string
                    description: This is the error code returned for the operation.
                    example: INVALID_REQUEST
                  errorReason:
                    type: string
                    description: This is the error reason returned for the operation.
                    example: The request parameters are invalid.
  /token-vault/{OwnerType}/{OwnerId}/vaults/gateway-tokens/{GatewayTokenId}/card-data:
    get:
      summary: Get masked card data related to gateway token
      description: >-
        Request to get card data related to the gateway token. The returned
        sensitive data is unencrypted but masked to ensure security.
      operationId: get-masked-card-related-to-gateway-token
      parameters:
        - name: OwnerId
          in: path
          description: >-
            The unique identifier of the entity owning the token (e.g.,
            Referrer, Merchant Group, Merchant, Site).
          required: true
          example: MERCHANT-GROUP-1
          style: simple
          schema:
            maxLength: 20
            minLength: 0
            type: string
        - name: OwnerType
          in: path
          description: >-
            The type of entity owning the token (e.g., Referrer, MerchantGroup,
            Merchant or Site).
          required: true
          example: MerchantGroup
          style: simple
          schema:
            enum:
              - Referrer
              - MerchantGroup
              - Merchant
              - Site
            type: string
        - name: GatewayTokenId
          in: path
          description: >-
            The gateway token Id represents a securely stored token that
            corresponds to a previously saved payment card. This token is
            generated and maintained by PXP to facilitate recurring transactions
            or transactions using stored card details, ensuring enhanced
            security and convenience. When a transaction is performed with a
            saved card, this token Id should be provided instead of the full
            card details. This approach enhances security by reducing the
            exposure of sensitive card information and simplifies the
            transaction process for returning customers."
          required: true
          style: simple
          example: 7f46c09d-d1d1-4f94-9a88-6e8ac32e6341
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: Successful retrieval of masked card data
          content:
            application/json:
              schema:
                type: object
                properties:
                  maskedPrimaryAccountNumber:
                    description: The masked primary account number (PAN) of the card.
                    type: string
                    example: 123456******7890
                  expiryMonth:
                    description: This is the expiry month [MM] of the card.
                    type: string
                    example: '03'
                  expiryYear:
                    description: This is the expiry year [YYYY] of the card.
                    type: string
                    example: '2025'
                  holderName:
                    description: >-
                      The Cardholder Name represents the full name of the
                      individual who owns the payment card. This name is printed
                      on the physical card and is used for verifying the
                      cardholder's identity during transactions. The cardholder
                      name is a vital component for transaction processing,
                      especially in cases of card-not-present transactions like
                      online purchases. It should be treated with
                      confidentiality to safeguard the cardholder's privacy and
                      prevent potential misuse.
                    type: string
                    example: Mr John Doe
                  fundingSource:
                    description: The funding source type (e.g., Credit Card).
                    type: string
                    example: Credit Card
                    nullable: true
                additionalProperties: false
              examples:
                Get Gateway Token Card Data Response:
                  value:
                    maskedPrimaryAccountNumber: 123456******7890
                    expiryMonth: '12'
                    expiryYear: '2025'
                    holderName: Mr John Doe
                    fundingSource: Credit Card
        '400':
          description: Bad request due to invalid input
          content:
            application/json:
              schema:
                type: object
                properties:
                  correlationId:
                    type: string
                    description: >-
                      A unique identifier generated by PXP, serving as a
                      critical tool for tracing and diagnosing transaction
                      errors. This Id allows for the precise location of
                      transactional issues, facilitating swift investigation and
                      resolution by correlating specific transaction attempts or
                      processes with error logs. Essential for support and
                      operational teams, the correlationId enhances PXP's
                      ability to maintain high-quality service and transaction
                      reliability.
                    example: 81f32b80-2ba0-4430-8ecd-0b559274ba9c
                  details:
                    type: array
                    items: {}
                    description: Additional details about the error.
                  errorCode:
                    type: string
                    description: This is the error code returned for the operation.
                    example: INVALID_REQUEST
                  errorReason:
                    type: string
                    description: This is the error reason returned for the operation.
                    example: The request parameters are invalid.
        '401':
          description: Unauthorized access
          content:
            application/json:
              schema:
                type: object
                properties:
                  correlationId:
                    type: string
                    description: >-
                      A unique identifier generated by PXP, serving as a
                      critical tool for tracing and diagnosing transaction
                      errors. This Id allows for the precise location of
                      transactional issues, facilitating swift investigation and
                      resolution by correlating specific transaction attempts or
                      processes with error logs. Essential for support and
                      operational teams, the correlationId enhances PXP's
                      ability to maintain high-quality service and transaction
                      reliability.
                    example: 81f32b80-2ba0-4430-8ecd-0b559274ba9c
                  details:
                    type: array
                    items: {}
                    description: Additional details about the error.
                  errorCode:
                    type: string
                    description: This is the error code returned for the operation.
                    example: INVALID_REQUEST
                  errorReason:
                    type: string
                    description: This is the error reason returned for the operation.
                    example: The request parameters are invalid.
        '403':
          description: Forbidden access
          content:
            application/json:
              schema:
                type: object
                properties:
                  correlationId:
                    type: string
                    description: >-
                      A unique identifier generated by PXP, serving as a
                      critical tool for tracing and diagnosing transaction
                      errors. This Id allows for the precise location of
                      transactional issues, facilitating swift investigation and
                      resolution by correlating specific transaction attempts or
                      processes with error logs. Essential for support and
                      operational teams, the correlationId enhances PXP's
                      ability to maintain high-quality service and transaction
                      reliability.
                    example: 81f32b80-2ba0-4430-8ecd-0b559274ba9c
                  details:
                    type: array
                    items: {}
                    description: Additional details about the error.
                  errorCode:
                    type: string
                    description: This is the error code returned for the operation.
                    example: INVALID_REQUEST
                  errorReason:
                    type: string
                    description: This is the error reason returned for the operation.
                    example: The request parameters are invalid.
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  correlationId:
                    type: string
                    description: >-
                      A unique identifier generated by PXP, serving as a
                      critical tool for tracing and diagnosing transaction
                      errors. This Id allows for the precise location of
                      transactional issues, facilitating swift investigation and
                      resolution by correlating specific transaction attempts or
                      processes with error logs. Essential for support and
                      operational teams, the correlationId enhances PXP's
                      ability to maintain high-quality service and transaction
                      reliability.
                    example: 81f32b80-2ba0-4430-8ecd-0b559274ba9c
                  details:
                    type: array
                    items: {}
                    description: Additional details about the error.
                  errorCode:
                    type: string
                    description: This is the error code returned for the operation.
                    example: INVALID_REQUEST
                  errorReason:
                    type: string
                    description: This is the error reason returned for the operation.
                    example: The request parameters are invalid.
        '413':
          description: Payload too large
          content:
            application/json:
              schema:
                type: object
                properties:
                  correlationId:
                    type: string
                    description: >-
                      A unique identifier generated by PXP, serving as a
                      critical tool for tracing and diagnosing transaction
                      errors. This Id allows for the precise location of
                      transactional issues, facilitating swift investigation and
                      resolution by correlating specific transaction attempts or
                      processes with error logs. Essential for support and
                      operational teams, the correlationId enhances PXP's
                      ability to maintain high-quality service and transaction
                      reliability.
                    example: 81f32b80-2ba0-4430-8ecd-0b559274ba9c
                  details:
                    type: array
                    items: {}
                    description: Additional details about the error.
                  errorCode:
                    type: string
                    description: This is the error code returned for the operation.
                    example: INVALID_REQUEST
                  errorReason:
                    type: string
                    description: This is the error reason returned for the operation.
                    example: The request parameters are invalid.
        '422':
          description: Unprocessable entity due to semantic errors
          content:
            application/json:
              schema:
                type: object
                properties:
                  correlationId:
                    type: string
                    description: >-
                      A unique identifier generated by PXP, serving as a
                      critical tool for tracing and diagnosing transaction
                      errors. This Id allows for the precise location of
                      transactional issues, facilitating swift investigation and
                      resolution by correlating specific transaction attempts or
                      processes with error logs. Essential for support and
                      operational teams, the correlationId enhances PXP's
                      ability to maintain high-quality service and transaction
                      reliability.
                    example: 81f32b80-2ba0-4430-8ecd-0b559274ba9c
                  details:
                    type: array
                    items: {}
                    description: Additional details about the error.
                  errorCode:
                    type: string
                    description: This is the error code returned for the operation.
                    example: INVALID_REQUEST
                  errorReason:
                    type: string
                    description: This is the error reason returned for the operation.
                    example: The request parameters are invalid.
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                type: object
                properties:
                  correlationId:
                    type: string
                    description: >-
                      A unique identifier generated by PXP, serving as a
                      critical tool for tracing and diagnosing transaction
                      errors. This Id allows for the precise location of
                      transactional issues, facilitating swift investigation and
                      resolution by correlating specific transaction attempts or
                      processes with error logs. Essential for support and
                      operational teams, the correlationId enhances PXP's
                      ability to maintain high-quality service and transaction
                      reliability.
                    example: 81f32b80-2ba0-4430-8ecd-0b559274ba9c
                  details:
                    type: array
                    items: {}
                    description: Additional details about the error.
                  errorCode:
                    type: string
                    description: This is the error code returned for the operation.
                    example: INVALID_REQUEST
                  errorReason:
                    type: string
                    description: This is the error reason returned for the operation.
                    example: The request parameters are invalid.
  /token-vault/{OwnerType}/{OwnerId}/vaults/gateway-tokens/{GatewayTokenId}/card-data/encrypted:
    get:
      summary: Get encrypted card data related to gateway token
      description: >-
        Request to get card data related to the gateway token. The returned
        sensitive data is encrypted for enhanced security.
      operationId: get-encrypted-card-related-to-gateway-token
      parameters:
        - name: OwnerId
          in: path
          description: >-
            The unique identifier of the entity owning the token (e.g.,
            Referrer, Merchant Group, Merchant, Site).
          required: true
          example: MERCHANT-GROUP-1
          style: simple
          schema:
            maxLength: 20
            minLength: 0
            type: string
        - name: OwnerType
          in: path
          description: >-
            The type of entity owning the token (e.g., Referrer, MerchantGroup,
            Merchant or Site).
          required: true
          example: MerchantGroup
          style: simple
          schema:
            enum:
              - Referrer
              - MerchantGroup
              - Merchant
              - Site
            type: string
        - name: GatewayTokenId
          in: path
          description: >-
            The gateway token Id represents a securely stored token that
            corresponds to a previously saved payment card. This token is
            generated and maintained by PXP to facilitate recurring transactions
            or transactions using stored card details, ensuring enhanced
            security and convenience. When a transaction is performed with a
            saved card, this token Id should be provided instead of the full
            card details. This approach enhances security by reducing the
            exposure of sensitive card information and simplifies the
            transaction process for returning customers."
          required: true
          style: simple
          example: 7f46c09d-d1d1-4f94-9a88-6e8ac32e6341
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: Successful retrieval of encrypted card data
          content:
            application/json:
              schema:
                type: object
                properties:
                  encryptedPrimaryAccountNumber:
                    description: The encrypted primary account number (PAN) of the card.
                    type: string
                    format: byte
                    example: QWxhZGRpbjpvcGVuIHNlc2FtZQ==
                  expiryMonth:
                    description: This is the expiry month [MM] of the card.
                    type: string
                    example: '03'
                  expiryYear:
                    description: This is the expiry year [YYYY] of the card.
                    type: string
                    example: '2025'
                  encryptedHolderName:
                    description: The encrypted name of the cardholder.
                    type: string
                    example: Sm9obiBEb2U=
                    format: byte
                  fundingSource:
                    description: The funding source type (e.g., Credit Card).
                    type: string
                    nullable: true
                    example: Credit Card
                additionalProperties: false
              examples:
                Get Gateway Token Encrypted Card Data Response:
                  value:
                    encryptedPrimaryAccountNumber: QWxhZGRpbjpvcGVuIHNlc2FtZQ==
                    expiryMonth: '12'
                    expiryYear: '2025'
                    encryptedHolderName: Sm9obiBEb2U=
                    fundingSource: Credit Card
        '400':
          description: Bad request due to invalid input
          content:
            application/json:
              schema:
                type: object
                properties:
                  correlationId:
                    type: string
                    description: >-
                      A unique identifier generated by PXP, serving as a
                      critical tool for tracing and diagnosing transaction
                      errors. This Id allows for the precise location of
                      transactional issues, facilitating swift investigation and
                      resolution by correlating specific transaction attempts or
                      processes with error logs. Essential for support and
                      operational teams, the correlationId enhances PXP's
                      ability to maintain high-quality service and transaction
                      reliability.
                    example: 81f32b80-2ba0-4430-8ecd-0b559274ba9c
                  details:
                    type: array
                    items: {}
                    description: Additional details about the error.
                  errorCode:
                    type: string
                    description: This is the error code returned for the operation.
                    example: INVALID_REQUEST
                  errorReason:
                    type: string
                    description: This is the error reason returned for the operation.
                    example: The request parameters are invalid.
        '401':
          description: Unauthorised access
          content:
            application/json:
              schema:
                type: object
                properties:
                  correlationId:
                    type: string
                    description: >-
                      A unique identifier generated by PXP, serving as a
                      critical tool for tracing and diagnosing transaction
                      errors. This Id allows for the precise location of
                      transactional issues, facilitating swift investigation and
                      resolution by correlating specific transaction attempts or
                      processes with error logs. Essential for support and
                      operational teams, the correlationId enhances PXP's
                      ability to maintain high-quality service and transaction
                      reliability.
                    example: 81f32b80-2ba0-4430-8ecd-0b559274ba9c
                  details:
                    type: array
                    items: {}
                    description: Additional details about the error.
                  errorCode:
                    type: string
                    description: This is the error code returned for the operation.
                    example: INVALID_REQUEST
                  errorReason:
                    type: string
                    description: This is the error reason returned for the operation.
                    example: The request parameters are invalid.
        '403':
          description: Forbidden access
          content:
            application/json:
              schema:
                type: object
                properties:
                  correlationId:
                    type: string
                    description: >-
                      A unique identifier generated by PXP, serving as a
                      critical tool for tracing and diagnosing transaction
                      errors. This Id allows for the precise location of
                      transactional issues, facilitating swift investigation and
                      resolution by correlating specific transaction attempts or
                      processes with error logs. Essential for support and
                      operational teams, the correlationId enhances PXP's
                      ability to maintain high-quality service and transaction
                      reliability.
                    example: 81f32b80-2ba0-4430-8ecd-0b559274ba9c
                  details:
                    type: array
                    items: {}
                    description: Additional details about the error.
                  errorCode:
                    type: string
                    description: This is the error code returned for the operation.
                    example: INVALID_REQUEST
                  errorReason:
                    type: string
                    description: This is the error reason returned for the operation.
                    example: The request parameters are invalid.
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  correlationId:
                    type: string
                    description: >-
                      A unique identifier generated by PXP, serving as a
                      critical tool for tracing and diagnosing transaction
                      errors. This Id allows for the precise location of
                      transactional issues, facilitating swift investigation and
                      resolution by correlating specific transaction attempts or
                      processes with error logs. Essential for support and
                      operational teams, the correlationId enhances PXP's
                      ability to maintain high-quality service and transaction
                      reliability.
                    example: 81f32b80-2ba0-4430-8ecd-0b559274ba9c
                  details:
                    type: array
                    items: {}
                    description: Additional details about the error.
                  errorCode:
                    type: string
                    description: This is the error code returned for the operation.
                    example: INVALID_REQUEST
                  errorReason:
                    type: string
                    description: This is the error reason returned for the operation.
                    example: The request parameters are invalid.
        '413':
          description: Payload too large
          content:
            application/json:
              schema:
                type: object
                properties:
                  correlationId:
                    type: string
                    description: >-
                      A unique identifier generated by PXP, serving as a
                      critical tool for tracing and diagnosing transaction
                      errors. This Id allows for the precise location of
                      transactional issues, facilitating swift investigation and
                      resolution by correlating specific transaction attempts or
                      processes with error logs. Essential for support and
                      operational teams, the correlationId enhances PXP's
                      ability to maintain high-quality service and transaction
                      reliability.
                    example: 81f32b80-2ba0-4430-8ecd-0b559274ba9c
                  details:
                    type: array
                    items: {}
                    description: Additional details about the error.
                  errorCode:
                    type: string
                    description: This is the error code returned for the operation.
                    example: INVALID_REQUEST
                  errorReason:
                    type: string
                    description: This is the error reason returned for the operation.
                    example: The request parameters are invalid.
        '422':
          description: Unprocessable entity due to semantic errors
          content:
            application/json:
              schema:
                type: object
                properties:
                  correlationId:
                    type: string
                    description: >-
                      A unique identifier generated by PXP, serving as a
                      critical tool for tracing and diagnosing transaction
                      errors. This Id allows for the precise location of
                      transactional issues, facilitating swift investigation and
                      resolution by correlating specific transaction attempts or
                      processes with error logs. Essential for support and
                      operational teams, the correlationId enhances PXP's
                      ability to maintain high-quality service and transaction
                      reliability.
                    example: 81f32b80-2ba0-4430-8ecd-0b559274ba9c
                  details:
                    type: array
                    items: {}
                    description: Additional details about the error.
                  errorCode:
                    type: string
                    description: This is the error code returned for the operation.
                    example: INVALID_REQUEST
                  errorReason:
                    type: string
                    description: This is the error reason returned for the operation.
                    example: The request parameters are invalid.
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                type: object
                properties:
                  correlationId:
                    type: string
                    description: >-
                      A unique identifier generated by PXP, serving as a
                      critical tool for tracing and diagnosing transaction
                      errors. This Id allows for the precise location of
                      transactional issues, facilitating swift investigation and
                      resolution by correlating specific transaction attempts or
                      processes with error logs. Essential for support and
                      operational teams, the correlationId enhances PXP's
                      ability to maintain high-quality service and transaction
                      reliability.
                    example: 81f32b80-2ba0-4430-8ecd-0b559274ba9c
                  details:
                    type: array
                    items: {}
                    description: Additional details about the error.
                  errorCode:
                    type: string
                    description: This is the error code returned for the operation.
                    example: INVALID_REQUEST
                  errorReason:
                    type: string
                    description: This is the error reason returned for the operation.
                    example: The request parameters are invalid.
  /token-vault/{OwnerType}/{OwnerId}/vaults/gateway-tokens/{GatewayTokenId}/card-verification-code:
    put:
      summary: Store card verification code for card
      description: >-
        Request to store the card verification code (CVC) for a card associated
        with a gateway token.
      operationId: store-security-code
      parameters:
        - name: OwnerId
          in: path
          description: >-
            The unique identifier of the entity owning the token (e.g.,
            Referrer, Merchant Group, Merchant, Site).
          required: true
          example: MERCHANT-GROUP-1
          style: simple
          schema:
            maxLength: 20
            minLength: 0
            type: string
        - name: OwnerType
          in: path
          description: >-
            The type of entity owning the token (e.g., Referrer, MerchantGroup,
            Merchant or Site).
          required: true
          example: MerchantGroup
          style: simple
          schema:
            enum:
              - Referrer
              - MerchantGroup
              - Merchant
              - Site
            type: string
        - name: GatewayTokenId
          in: path
          description: >-
            The gateway token Id represents a securely stored token that
            corresponds to a previously saved payment card. This token is
            generated and maintained by PXP to facilitate recurring transactions
            or transactions using stored card details, ensuring enhanced
            security and convenience. When a transaction is performed with a
            saved card, this token Id should be provided instead of the full
            card details. This approach enhances security by reducing the
            exposure of sensitive card information and simplifies the
            transaction process for returning customers."
          required: true
          style: simple
          example: 7f46c09d-d1d1-4f94-9a88-6e8ac32e6341
          schema:
            type: string
            format: uuid
      requestBody:
        content:
          application/json:
            schema:
              required:
                - cardVerificationCode
              type: object
              properties:
                cardVerificationCode:
                  description: >-
                    Represents the Card Verification Code (CVC) associated with
                    the payment card, a security feature for transactions where
                    the card is not physically present. The security code is
                    typically a 3 or 4 digit number found on the card, used to
                    verify that the cardholder is in possession of the card
                    during non-face-to-face transactions.
                  maxLength: 4
                  minLength: 3
                  example: '123'
                  type: string
              additionalProperties: false
      responses:
        '200':
          description: Successful storage of the card verification code
        '400':
          description: Bad request due to invalid input
          content:
            application/json:
              schema:
                type: object
                properties:
                  correlationId:
                    type: string
                    description: >-
                      A unique identifier generated by PXP, serving as a
                      critical tool for tracing and diagnosing transaction
                      errors. This Id allows for the precise location of
                      transactional issues, facilitating swift investigation and
                      resolution by correlating specific transaction attempts or
                      processes with error logs. Essential for support and
                      operational teams, the correlationId enhances PXP's
                      ability to maintain high-quality service and transaction
                      reliability.
                    example: 81f32b80-2ba0-4430-8ecd-0b559274ba9c
                  details:
                    type: array
                    items: {}
                    description: Additional details about the error.
                  errorCode:
                    type: string
                    description: This is the error code returned for the operation.
                    example: INVALID_REQUEST
                  errorReason:
                    type: string
                    description: This is the error reason returned for the operation.
                    example: The request parameters are invalid.
        '401':
          description: Unauthorised access
          content:
            application/json:
              schema:
                type: object
                properties:
                  correlationId:
                    type: string
                    description: >-
                      A unique identifier generated by PXP, serving as a
                      critical tool for tracing and diagnosing transaction
                      errors. This Id allows for the precise location of
                      transactional issues, facilitating swift investigation and
                      resolution by correlating specific transaction attempts or
                      processes with error logs. Essential for support and
                      operational teams, the correlationId enhances PXP's
                      ability to maintain high-quality service and transaction
                      reliability.
                    example: 81f32b80-2ba0-4430-8ecd-0b559274ba9c
                  details:
                    type: array
                    items: {}
                    description: Additional details about the error.
                  errorCode:
                    type: string
                    description: This is the error code returned for the operation.
                    example: INVALID_REQUEST
                  errorReason:
                    type: string
                    description: This is the error reason returned for the operation.
                    example: The request parameters are invalid.
        '403':
          description: Forbidden access
          content:
            application/json:
              schema:
                type: object
                properties:
                  correlationId:
                    type: string
                    description: >-
                      A unique identifier generated by PXP, serving as a
                      critical tool for tracing and diagnosing transaction
                      errors. This Id allows for the precise location of
                      transactional issues, facilitating swift investigation and
                      resolution by correlating specific transaction attempts or
                      processes with error logs. Essential for support and
                      operational teams, the correlationId enhances PXP's
                      ability to maintain high-quality service and transaction
                      reliability.
                    example: 81f32b80-2ba0-4430-8ecd-0b559274ba9c
                  details:
                    type: array
                    items: {}
                    description: Additional details about the error.
                  errorCode:
                    type: string
                    description: This is the error code returned for the operation.
                    example: INVALID_REQUEST
                  errorReason:
                    type: string
                    description: This is the error reason returned for the operation.
                    example: The request parameters are invalid.
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  correlationId:
                    type: string
                    description: >-
                      A unique identifier generated by PXP, serving as a
                      critical tool for tracing and diagnosing transaction
                      errors. This Id allows for the precise location of
                      transactional issues, facilitating swift investigation and
                      resolution by correlating specific transaction attempts or
                      processes with error logs. Essential for support and
                      operational teams, the correlationId enhances PXP's
                      ability to maintain high-quality service and transaction
                      reliability.
                    example: 81f32b80-2ba0-4430-8ecd-0b559274ba9c
                  details:
                    type: array
                    items: {}
                    description: Additional details about the error.
                  errorCode:
                    type: string
                    description: This is the error code returned for the operation.
                    example: INVALID_REQUEST
                  errorReason:
                    type: string
                    description: This is the error reason returned for the operation.
                    example: The request parameters are invalid.
        '413':
          description: Payload too large
          content:
            application/json:
              schema:
                type: object
                properties:
                  correlationId:
                    type: string
                    description: >-
                      A unique identifier generated by PXP, serving as a
                      critical tool for tracing and diagnosing transaction
                      errors. This Id allows for the precise location of
                      transactional issues, facilitating swift investigation and
                      resolution by correlating specific transaction attempts or
                      processes with error logs. Essential for support and
                      operational teams, the correlationId enhances PXP's
                      ability to maintain high-quality service and transaction
                      reliability.
                    example: 81f32b80-2ba0-4430-8ecd-0b559274ba9c
                  details:
                    type: array
                    items: {}
                    description: Additional details about the error.
                  errorCode:
                    type: string
                    description: This is the error code returned for the operation.
                    example: INVALID_REQUEST
                  errorReason:
                    type: string
                    description: This is the error reason returned for the operation.
                    example: The request parameters are invalid.
        '422':
          description: Unprocessable entity due to semantic errors
          content:
            application/json:
              schema:
                type: object
                properties:
                  correlationId:
                    type: string
                    description: >-
                      A unique identifier generated by PXP, serving as a
                      critical tool for tracing and diagnosing transaction
                      errors. This Id allows for the precise location of
                      transactional issues, facilitating swift investigation and
                      resolution by correlating specific transaction attempts or
                      processes with error logs. Essential for support and
                      operational teams, the correlationId enhances PXP's
                      ability to maintain high-quality service and transaction
                      reliability.
                    example: 81f32b80-2ba0-4430-8ecd-0b559274ba9c
                  details:
                    type: array
                    items: {}
                    description: Additional details about the error.
                  errorCode:
                    type: string
                    description: This is the error code returned for the operation.
                    example: INVALID_REQUEST
                  errorReason:
                    type: string
                    description: This is the error reason returned for the operation.
                    example: The request parameters are invalid.
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                type: object
                properties:
                  correlationId:
                    type: string
                    description: >-
                      A unique identifier generated by PXP, serving as a
                      critical tool for tracing and diagnosing transaction
                      errors. This Id allows for the precise location of
                      transactional issues, facilitating swift investigation and
                      resolution by correlating specific transaction attempts or
                      processes with error logs. Essential for support and
                      operational teams, the correlationId enhances PXP's
                      ability to maintain high-quality service and transaction
                      reliability.
                    example: 81f32b80-2ba0-4430-8ecd-0b559274ba9c
                  details:
                    type: array
                    items: {}
                    description: Additional details about the error.
                  errorCode:
                    type: string
                    description: This is the error code returned for the operation.
                    example: INVALID_REQUEST
                  errorReason:
                    type: string
                    description: This is the error reason returned for the operation.
                    example: The request parameters are invalid.
components:
  schemas:
    Pxp.Unity.Api.Gateway.Transactions.Contracts.TokenVault.Requests.AddCardVerificationCodeRequestBody:
      required:
        - cardVerificationCode
      type: object
      properties:
        cardVerificationCode:
          description: >-
            Represents the Card Verification Code (CVC) associated with the
            payment card, a security feature for transactions where the card is
            not physically present. The security code is typically a 3 or 4
            digit number found on the card, used to verify that the cardholder
            is in possession of the card during non-face-to-face transactions.
          maxLength: 4
          minLength: 3
          example: '123'
          type: string
      additionalProperties: false
    Pxp.Unity.Api.Gateway.Transactions.Contracts.TokenVault.Requests.CreateGatewayTokenRequest:
      required:
        - primaryAccountNumber
        - expiryMonth
        - expiryYear
        - holderName
      type: object
      properties:
        primaryAccountNumber:
          description: >-
            This refers to the unique number assigned to a payment card, such as
            a credit or debit card. This number typically contains 16 digits,
            structured in a specific format to indicate the card network,
            issuing bank, and account number.
          type: string
          example: '4111111111111111111'
        expiryMonth:
          description: This is the expiry month [MM] of the card.
          type: string
          example: '03'
        expiryYear:
          description: This is the expiry year [YYYY] of the card.
          type: string
          example: '2025'
        cardVerificationCode:
          description: >-
            Represents the Card Verification Code (CVC) associated with the
            payment card, a security feature for transactions where the card is
            not physically present. The security code is typically a 3 or 4
            digit number found on the card, used to verify that the cardholder
            is in possession of the card during non-face-to-face transactions.
          type: string
          example: '123'
          nullable: true
        holderName:
          description: >-
            The Cardholder Name represents the full name of the individual who
            owns the payment card. This name is printed on the physical card and
            is used for verifying the cardholder's identity during transactions.
            The cardholder name is a vital component for transaction processing,
            especially in cases of card-not-present transactions like online
            purchases. It should be treated with confidentiality to safeguard
            the cardholder's privacy and prevent potential misuse.
          type: string
          example: Mr John Doe
      additionalProperties: false
    Pxp.Unity.Api.Gateway.Transactions.Contracts.TokenVault.Requests.CreateSchemeTokenRequest:
      required:
        - primaryAccountNumber
        - expiryMonth
        - expiryYear
        - holderName
      type: object
      properties:
        primaryAccountNumber:
          description: >-
            This refers to the unique number assigned to a payment card, such as
            a credit or debit card. This number typically contains 16 digits,
            structured in a specific format to indicate the card network,
            issuing bank, and account number.
          type: string
          example: '4111111111111111111'
        expiryMonth:
          description: This is the expiry month [MM] of the card.
          type: string
          example: '03'
        expiryYear:
          description: This is the expiry year [YYYY] of the card.
          type: string
          example: '2025'
        cardVerificationCode:
          description: >-
            Represents the Card Verification Code (CVC) associated with the
            payment card, a security feature for transactions where the card is
            not physically present. The security code is typically a 3 or 4
            digit number found on the card, used to verify that the cardholder
            is in possession of the card during non-face-to-face transactions.
          type: string
          example: '123'
          nullable: true
        holderName:
          description: >-
            The Cardholder Name represents the full name of the individual who
            owns the payment card. This name is printed on the physical card and
            is used for verifying the cardholder's identity during transactions.
            The cardholder name is a vital component for transaction processing,
            especially in cases of card-not-present transactions like online
            purchases. It should be treated with confidentiality to safeguard
            the cardholder's privacy and prevent potential misuse.
          type: string
          example: Mr John Doe
      additionalProperties: false
    Pxp.Unity.Api.Gateway.Transactions.Contracts.TokenVault.Responses.CryptogramResponse:
      type: object
      properties:
        schemeTokenCryptogram:
          description: >-
            A unique cryptogram generated during the tokenisation process,
            utilized for enhancing the security of transaction processing. This
            cryptogram acts as a secure and unique identifier, akin to the TAVV,
            ensuring that each transaction is authenticated and verified without
            directly using sensitive card details. It plays a crucial role in
            the secure electronic payment ecosystem, especially in tokenised
            transactions, by providing an additional layer of security and
            authentication.
          type: string
          example: E1F53135E559C253
          nullable: true
        schemeTokenNumber:
          description: >-
            The scheme token number represents a scheme token issued by Visa or
            Mastercard, used for subsequent transaction processing. This token
            enhances security and facilitates recurring transactions, providing
            a secure and efficient alternative to sharing sensitive card
            details.
          type: string
          example: '4837261112345678'
        cryptogramType:
          description: The type of cryptogram (e.g., 3DSecure).
          type: string
          example: 3DSecure
          nullable: true
        clientPaymentDataId:
          description: The client payment data identifier associated with the cryptogram.
          type: string
          nullable: true
          example: abc123
      additionalProperties: false
    Pxp.Unity.Api.Gateway.Transactions.Contracts.TokenVault.Responses.GatewayTokenResponse:
      type: object
      properties:
        gatewayTokenId:
          description: >-
            The gateway token Id represents a securely stored token that
            corresponds to a previously saved payment card. This token is
            generated and maintained by PXP to facilitate recurring transactions
            or transactions using stored card details, ensuring enhanced
            security and convenience. When a transaction is performed with a
            saved card, this token Id should be provided instead of the full
            card details. This approach enhances security by reducing the
            exposure of sensitive card information and simplifies the
            transaction process for returning customers."
          type: string
          example: 7f46c09d-d1d1-4f94-9a88-6e8ac32e6341
          format: uuid
        maskedPrimaryAccountNumber:
          description: The masked primary account number (PAN) of the card.
          type: string
          example: 123456******7890
        fundingSource:
          description: The funding source type (e.g., Credit Card).
          type: string
          example: Credit Card
          nullable: true
      additionalProperties: false
    Pxp.Unity.Api.Gateway.Transactions.Contracts.TokenVault.Responses.GetGatewayTokenCardDataResponse:
      type: object
      properties:
        maskedPrimaryAccountNumber:
          description: The masked primary account number (PAN) of the card.
          type: string
          example: 123456******7890
        expiryMonth:
          description: This is the expiry month [MM] of the card.
          type: string
          example: '03'
        expiryYear:
          description: This is the expiry year [YYYY] of the card.
          type: string
          example: '2025'
        holderName:
          description: >-
            The Cardholder Name represents the full name of the individual who
            owns the payment card. This name is printed on the physical card and
            is used for verifying the cardholder's identity during transactions.
            The cardholder name is a vital component for transaction processing,
            especially in cases of card-not-present transactions like online
            purchases. It should be treated with confidentiality to safeguard
            the cardholder's privacy and prevent potential misuse.
          type: string
          example: Mr John Doe
        fundingSource:
          description: The funding source type (e.g., Credit Card).
          type: string
          example: Credit Card
          nullable: true
      additionalProperties: false
    Pxp.Unity.Api.Gateway.Transactions.Contracts.TokenVault.Responses.GetGatewayTokenEncryptedCardDataResponse:
      type: object
      properties:
        encryptedPrimaryAccountNumber:
          description: The encrypted primary account number (PAN) of the card.
          type: string
          format: byte
          example: QWxhZGRpbjpvcGVuIHNlc2FtZQ==
        expiryMonth:
          description: This is the expiry month [MM] of the card.
          type: string
          example: '03'
        expiryYear:
          description: This is the expiry year [YYYY] of the card.
          type: string
          example: '2025'
        encryptedHolderName:
          description: The encrypted name of the cardholder.
          type: string
          example: Sm9obiBEb2U=
          format: byte
        fundingSource:
          description: The funding source type (e.g., Credit Card).
          type: string
          nullable: true
          example: Credit Card
      additionalProperties: false
    Pxp.Unity.Api.Gateway.Transactions.Contracts.TokenVault.Responses.SchemeTokenResponse:
      type: object
      properties:
        schemeTokenId:
          description: >-
            The unique scheme token Id generated by PXP. It is used as a
            reference to extract the schemeTokenNumber.
          type: string
          format: uuid
        fundingSource:
          description: The funding source type (e.g., Bank Account).
          type: string
          example: Credit Card
          nullable: true
      additionalProperties: false
    Pxp.Unity.Api.Gateway.Transactions.Contracts.TokenVault.Responses.GetSchemeTokenResponse:
      type: object
      properties:
        schemeTokenId:
          type: string
          format: uuid
          description: >-
            The unique scheme token Id generated by PXP. It is used as a
            reference to extract the schemeTokenNumber.
        schemeTokenProvider:
          type: string
          description: The name of the scheme token provider.
        schemeTokenProcurementState:
          type: string
          description: The procurement state of the scheme token.
        externalSchemeTokenId:
          type: string
          nullable: true
          description: >-
            A unique identifier token provided by the external payment scheme.
            This token allows merchants to process payments through different
            payment service providers (PSPs) or transaction service providers
            (TSPs). The token facilitates interoperability between different
            PSPs, enabling merchants to seamlessly integrate with and utilize
            various payment processing services.
        status:
          type: string
          nullable: true
          description: The status of the scheme token.
        paymentAccountReference:
          type: string
          nullable: true
          description: The payment account reference associated with the scheme token.
        schemeTokenNumber:
          type: string
          nullable: true
          description: >-
            The scheme token number represents a scheme token issued by Visa or
            Mastercard, used for subsequent transaction processing. This token
            enhances security and facilitates recurring transactions, providing
            a secure and efficient alternative to sharing sensitive card
            details.
        expiryMonth:
          type: string
          nullable: true
          description: This is the expiry year [YYYY] of the card.
        expiryYear:
          type: string
          nullable: true
          description: This is the expiry month [MM] of the card.
    inline_response_400:
      type: object
      properties:
        correlationId:
          type: string
          description: >-
            A unique identifier generated by PXP, serving as a critical tool for
            tracing and diagnosing transaction errors. This Id allows for the
            precise location of transactional issues, facilitating swift
            investigation and resolution by correlating specific transaction
            attempts or processes with error logs. Essential for support and
            operational teams, the correlationId enhances PXP's ability to
            maintain high-quality service and transaction reliability.
          example: 81f32b80-2ba0-4430-8ecd-0b559274ba9c
        details:
          type: array
          items: {}
          description: Additional details about the error.
        errorCode:
          type: string
          description: This is the error code returned for the operation.
          example: INVALID_REQUEST
        errorReason:
          type: string
          description: This is the error reason returned for the operation.
          example: The request parameters are invalid.
    inline_response_401:
      type: object
      properties:
        correlationId:
          type: string
          description: >-
            A unique identifier generated by PXP, serving as a critical tool for
            tracing and diagnosing transaction errors. This Id allows for the
            precise location of transactional issues, facilitating swift
            investigation and resolution by correlating specific transaction
            attempts or processes with error logs. Essential for support and
            operational teams, the correlationId enhances PXP's ability to
            maintain high-quality service and transaction reliability.
          example: 81f32b80-2ba0-4430-8ecd-0b559274ba9c
        details:
          type: array
          items: {}
          description: Additional details about the error.
        errorCode:
          type: string
          description: This is the error code returned for the operation.
          example: INVALID_REQUEST
        errorReason:
          type: string
          description: This is the error reason returned for the operation.
          example: The request parameters are invalid.
    inline_response_403:
      type: object
      properties:
        correlationId:
          type: string
          description: >-
            A unique identifier generated by PXP, serving as a critical tool for
            tracing and diagnosing transaction errors. This Id allows for the
            precise location of transactional issues, facilitating swift
            investigation and resolution by correlating specific transaction
            attempts or processes with error logs. Essential for support and
            operational teams, the correlationId enhances PXP's ability to
            maintain high-quality service and transaction reliability.
          example: 81f32b80-2ba0-4430-8ecd-0b559274ba9c
        details:
          type: array
          items: {}
          description: Additional details about the error.
        errorCode:
          type: string
          description: This is the error code returned for the operation.
          example: INVALID_REQUEST
        errorReason:
          type: string
          description: This is the error reason returned for the operation.
          example: The request parameters are invalid.
    inline_response_404:
      type: object
      properties:
        correlationId:
          type: string
          description: >-
            A unique identifier generated by PXP, serving as a critical tool for
            tracing and diagnosing transaction errors. This Id allows for the
            precise location of transactional issues, facilitating swift
            investigation and resolution by correlating specific transaction
            attempts or processes with error logs. Essential for support and
            operational teams, the correlationId enhances PXP's ability to
            maintain high-quality service and transaction reliability.
          example: 81f32b80-2ba0-4430-8ecd-0b559274ba9c
        details:
          type: array
          items: {}
          description: Additional details about the error.
        errorCode:
          type: string
          description: This is the error code returned for the operation.
          example: INVALID_REQUEST
        errorReason:
          type: string
          description: This is the error reason returned for the operation.
          example: The request parameters are invalid.
    inline_response_413:
      type: object
      properties:
        correlationId:
          type: string
          description: >-
            A unique identifier generated by PXP, serving as a critical tool for
            tracing and diagnosing transaction errors. This Id allows for the
            precise location of transactional issues, facilitating swift
            investigation and resolution by correlating specific transaction
            attempts or processes with error logs. Essential for support and
            operational teams, the correlationId enhances PXP's ability to
            maintain high-quality service and transaction reliability.
          example: 81f32b80-2ba0-4430-8ecd-0b559274ba9c
        details:
          type: array
          items: {}
          description: Additional details about the error.
        errorCode:
          type: string
          description: This is the error code returned for the operation.
          example: INVALID_REQUEST
        errorReason:
          type: string
          description: This is the error reason returned for the operation.
          example: The request parameters are invalid.
    inline_response_422:
      type: object
      properties:
        correlationId:
          type: string
          description: >-
            A unique identifier generated by PXP, serving as a critical tool for
            tracing and diagnosing transaction errors. This Id allows for the
            precise location of transactional issues, facilitating swift
            investigation and resolution by correlating specific transaction
            attempts or processes with error logs. Essential for support and
            operational teams, the correlationId enhances PXP's ability to
            maintain high-quality service and transaction reliability.
          example: 81f32b80-2ba0-4430-8ecd-0b559274ba9c
        details:
          type: array
          items: {}
          description: Additional details about the error.
        errorCode:
          type: string
          description: This is the error code returned for the operation.
          example: INVALID_REQUEST
        errorReason:
          type: string
          description: This is the error reason returned for the operation.
          example: The request parameters are invalid.
    inline_response_500:
      type: object
      properties:
        correlationId:
          type: string
          description: >-
            A unique identifier generated by PXP, serving as a critical tool for
            tracing and diagnosing transaction errors. This Id allows for the
            precise location of transactional issues, facilitating swift
            investigation and resolution by correlating specific transaction
            attempts or processes with error logs. Essential for support and
            operational teams, the correlationId enhances PXP's ability to
            maintain high-quality service and transaction reliability.
          example: 81f32b80-2ba0-4430-8ecd-0b559274ba9c
        details:
          type: array
          items: {}
          description: Additional details about the error.
        errorCode:
          type: string
          description: This is the error code returned for the operation.
          example: INVALID_REQUEST
        errorReason:
          type: string
          description: This is the error reason returned for the operation.
          example: The request parameters are invalid.
    correlationId:
      type: string
      description: >-
        A unique identifier generated by PXP, serving as a critical tool for
        tracing and diagnosing transaction errors. This Id allows for the
        precise location of transactional issues, facilitating swift
        investigation and resolution by correlating specific transaction
        attempts or processes with error logs. Essential for support and
        operational teams, the correlationId enhances PXP's ability to maintain
        high-quality service and transaction reliability.
      example: 81f32b80-2ba0-4430-8ecd-0b559274ba9c
    details:
      type: array
      items: {}
      description: Additional details about the error.
    errorCode:
      type: string
      description: This is the error code returned for the operation.
      example: INVALID_REQUEST
    errorReason:
      type: string
      description: This is the error reason returned for the operation.
      example: The request parameters are invalid.
