swagger: '2.0'
info:
  title: triPOS Transaction API
  version: 4.8.2
host: triposcert.vantiv.com
basePath: /
schemes:
  - https
paths:
  /api/v1:
    get:
      parameters:
        - description: The ID of the business application.
          in: header
          name: tp-application-id
          required: true
          type: string
        - description: The name of the business application.
          in: header
          name: tp-application-name
          required: true
          type: string
        - description: The version of the business application.
          in: header
          name: tp-application-version
          required: true
          type: string
        - description: The authorization header.
          in: header
          name: tp-authorization
          required: true
          type: string
        - description: >-
            The Express acceptorId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-acceptor-id
          required: true
          type: string
        - description: >-
            The Express accountId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-id
          required: true
          type: string
        - description: >-
            The Express accountToken. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-token
          required: true
          type: string
        - description: >-
            A unique ID for this request. This value should be a UUID or GUID.
            <a href='https://triposcert.vantiv.com/api/help/kb/requestid.html'>more&raquo;</a>
          in: header
          name: tp-request-id
          required: true
          type: string
        - description: Set to true to have logs populated in the response.
          in: header
          name: tp-return-logs
          required: false
          type: boolean
        - default: application/json
          description: Content type for request.
          in: header
          name: Content-Type
          required: true
          type: string
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/GetServicesResponse'
      tags:
        - V1 Links
      description: "<b>DO NOT</b> use as a regular-interval\_health status check."
      operationId: getv1
      summary: Returns an array of links for accessing version 1.0 of the triPOS API
  /api/v1/authorization:
    post:
      parameters:
        - description: >-
            The action to perform with the authorization. This can either be
            'store' or 'forward'.
          in: query
          name: action
          required: false
          type: string
        - description: The request ID of the stored transaction to forward.
          in: query
          name: requestIdToForward
          required: false
          type: string
        - description: The ID of the business application.
          in: header
          name: tp-application-id
          required: true
          type: string
        - description: The name of the business application.
          in: header
          name: tp-application-name
          required: true
          type: string
        - description: The version of the business application.
          in: header
          name: tp-application-version
          required: true
          type: string
        - description: The authorization header.
          in: header
          name: tp-authorization
          required: true
          type: string
        - description: >-
            The Express acceptorId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-acceptor-id
          required: true
          type: string
        - description: >-
            The Express accountId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-id
          required: true
          type: string
        - description: >-
            The Express accountToken. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-token
          required: true
          type: string
        - description: >-
            A unique ID for this request. This value should be a UUID or GUID.
            <a href='https://triposcert.vantiv.com/api/help/kb/requestid.html'>more&raquo;</a>
          in: header
          name: tp-request-id
          required: true
          type: string
        - description: Set to true to have logs populated in the response.
          in: header
          name: tp-return-logs
          required: false
          type: boolean
        - default: application/json
          description: Content type for request.
          in: header
          name: Content-Type
          required: true
          type: string
        - in: body
          name: AuthorizationRequest
          required: false
          schema:
            $ref: '#/definitions/POST_AuthorizationRequest_v1_authorization'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/AuthorizationResponse'
        '400':
          description: >-
            1) Returned if client sends in all 5 of the healthcare values as
            positive values. 2) Returned if any healthcare field has a negative
            value. 3) Returned if healthcare Total field is less than sum of the
            other healthcare fields. 4) Returned if MarketCode is not
            HotelLodging but the request includes lodging parameters on a valid
            lodging request. 5) Returned if the lodging duration is less than 0
            on a valid lodging request.
        '401':
          description: >-
            Returned if the AcceptorId, AccountId, AccountToken and TerminalId
            (config file only) are not provided in the HTTP request header or in
            the config file.
      tags:
        - Authorization
      description: >-
        This creates a transaction used to hold funds when the total amount of
        the purchase is unknown. The Incremental Authorization HATEAOS link is
        supported for market codes that are supported by Express. Additionally,
        this endpoint supports QuickChip/PreRead functionality. See <a
        href='https://triposcert.vantiv.com/api/help/kb/cloud/QuickChipConfiguration.html'> QuickChip/PreRead
        documentation</a> for more information.
      operationId: postv1authorization
      summary: Creates a new card authorization based on the passed in parameters
  /api/v1/authorization/token:
    post:
      parameters:
        - description: The ID of the business application.
          in: header
          name: tp-application-id
          required: true
          type: string
        - description: The name of the business application.
          in: header
          name: tp-application-name
          required: true
          type: string
        - description: The version of the business application.
          in: header
          name: tp-application-version
          required: true
          type: string
        - description: The authorization header.
          in: header
          name: tp-authorization
          required: true
          type: string
        - description: >-
            The Express acceptorId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-acceptor-id
          required: true
          type: string
        - description: >-
            The Express accountId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-id
          required: true
          type: string
        - description: >-
            The Express accountToken. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-token
          required: true
          type: string
        - description: >-
            A unique ID for this request. This value should be a UUID or GUID.
            <a href='https://triposcert.vantiv.com/api/help/kb/requestid.html'>more&raquo;</a>
          in: header
          name: tp-request-id
          required: true
          type: string
        - description: Set to true to have logs populated in the response.
          in: header
          name: tp-return-logs
          required: false
          type: boolean
        - default: application/json
          description: Content type for request.
          in: header
          name: Content-Type
          required: true
          type: string
        - in: body
          name: TokenAuthorizationRequest
          required: false
          schema:
            $ref: >-
              #/definitions/POST_TokenAuthorizationRequest_v1_authorization_token
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/TokenAuthorizationResponse'
        '401':
          description: >-
            Returned if the AcceptorId, AccountId, AccountToken and TerminalId
            (config file only) are not provided in the HTTP request header or in
            the config file.
      tags:
        - Authorization
      description: >-
        See <a href='https://triposcert.vantiv.com/api/help/kb/omniToken.html'>OmniToken documentation</a> for
        more information.
      operationId: postv1authorizationtoken
      summary: >-
        Creates a new card authorization using a token based on the passed in
        amounts
  '/api/v1/authorization/{paymentAccountId}':
    post:
      parameters:
        - description: The payment account ID.
          in: path
          name: paymentAccountId
          required: true
          type: string
        - description: The ID of the business application.
          in: header
          name: tp-application-id
          required: true
          type: string
        - description: The name of the business application.
          in: header
          name: tp-application-name
          required: true
          type: string
        - description: The version of the business application.
          in: header
          name: tp-application-version
          required: true
          type: string
        - description: The authorization header.
          in: header
          name: tp-authorization
          required: true
          type: string
        - description: >-
            The Express acceptorId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-acceptor-id
          required: true
          type: string
        - description: >-
            The Express accountId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-id
          required: true
          type: string
        - description: >-
            The Express accountToken. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-token
          required: true
          type: string
        - description: >-
            A unique ID for this request. This value should be a UUID or GUID.
            <a href='https://triposcert.vantiv.com/api/help/kb/requestid.html'>more&raquo;</a>
          in: header
          name: tp-request-id
          required: true
          type: string
        - description: Set to true to have logs populated in the response.
          in: header
          name: tp-return-logs
          required: false
          type: boolean
        - default: application/json
          description: Content type for request.
          in: header
          name: Content-Type
          required: true
          type: string
        - in: body
          name: PaymentAccountAuthorizationRequest
          required: false
          schema:
            $ref: >-
              #/definitions/POST_PaymentAccountAuthorizationRequest_v1_authorization_paymentAccountId
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/PaymentAccountAuthorizationResponse'
        '401':
          description: >-
            Returned if the AcceptorId, AccountId, AccountToken and TerminalId
            (config file only) are not provided in the HTTP request header or in
            the config file.
      tags:
        - Authorization
      operationId: postv1authorizationpaymentAccountId
      summary: >-
        Creates a new payment account authorization based on the passed in
        amounts
  '/api/v1/authorization/{transactionId}/completion':
    post:
      parameters:
        - description: The ID of a previous authorization transaction.
          in: path
          name: transactionId
          required: true
          type: string
        - description: The ID of the business application.
          in: header
          name: tp-application-id
          required: true
          type: string
        - description: The name of the business application.
          in: header
          name: tp-application-name
          required: true
          type: string
        - description: The version of the business application.
          in: header
          name: tp-application-version
          required: true
          type: string
        - description: The authorization header.
          in: header
          name: tp-authorization
          required: true
          type: string
        - description: >-
            The Express acceptorId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-acceptor-id
          required: true
          type: string
        - description: >-
            The Express accountId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-id
          required: true
          type: string
        - description: >-
            The Express accountToken. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-token
          required: true
          type: string
        - description: >-
            A unique ID for this request. This value should be a UUID or GUID.
            <a href='https://triposcert.vantiv.com/api/help/kb/requestid.html'>more&raquo;</a>
          in: header
          name: tp-request-id
          required: true
          type: string
        - description: Set to true to have logs populated in the response.
          in: header
          name: tp-return-logs
          required: false
          type: boolean
        - default: application/json
          description: Content type for request.
          in: header
          name: Content-Type
          required: true
          type: string
        - in: body
          name: AuthorizationCompletionRequest
          required: false
          schema:
            $ref: >-
              #/definitions/POST_AuthorizationCompletionRequest_v1_authorization_transactionId_completion
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/AuthorizationCompletionResponse'
        '400':
          description: >-
            1) Returned if MarketCode is not HotelLodging but the request
            includes lodging parameters on a valid lodging request. 2) Returned
            if the lodging checkInDate or checkOutDate is not in the ISO 8601
            format of YYYY-MM-DD on a valid lodging request. 3) Returned if the
            lodging roomAmount is less than 0.00 on a valid lodging request. 4)
            Returned if the lodging duration is less than 0 on a valid lodging
            request.
        '401':
          description: >-
            Returned if the AcceptorId, AccountId, AccountToken and TerminalId
            (config file only) are not provided in the HTTP request header or in
            the config file.
      tags:
        - Authorization
      description: >-
        This completes the original authorization and initiates and exchange of
        funds. The transactionId is the value returned by the original
        authorization.
      operationId: postv1authorizationtransactionIdcompletion
      summary: Updates a previous card authorization with the final totals
  '/api/v1/authorization/{transactionId}/incremental':
    post:
      parameters:
        - description: The ID of a previous authorization transaction.
          in: path
          name: transactionId
          required: true
          type: string
        - description: The ID of the business application.
          in: header
          name: tp-application-id
          required: true
          type: string
        - description: The name of the business application.
          in: header
          name: tp-application-name
          required: true
          type: string
        - description: The version of the business application.
          in: header
          name: tp-application-version
          required: true
          type: string
        - description: The authorization header.
          in: header
          name: tp-authorization
          required: true
          type: string
        - description: >-
            The Express acceptorId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-acceptor-id
          required: true
          type: string
        - description: >-
            The Express accountId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-id
          required: true
          type: string
        - description: >-
            The Express accountToken. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-token
          required: true
          type: string
        - description: >-
            A unique ID for this request. This value should be a UUID or GUID.
            <a href='https://triposcert.vantiv.com/api/help/kb/requestid.html'>more&raquo;</a>
          in: header
          name: tp-request-id
          required: true
          type: string
        - description: Set to true to have logs populated in the response.
          in: header
          name: tp-return-logs
          required: false
          type: boolean
        - default: application/json
          description: Content type for request.
          in: header
          name: Content-Type
          required: true
          type: string
        - in: body
          name: IncrementalAuthorizationRequest
          required: false
          schema:
            $ref: >-
              #/definitions/POST_IncrementalAuthorizationRequest_v1_authorization_transactionId_incremental
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/IncrementalAuthorizationResponse'
        '400':
          description: >-
            1) Returned if the laneId, transactionId or transactionAmount are
            missing from the request. 2) Returned if the triPOS.config
            marketCode AND the request configuration marketCode are both null or
            default. One must be set to a non-default value. 3) Returned if your
            MarketCode is not HotelLodging but your request includes lodging
            parameters. 4) Returned if the lodging duration is less than 0 on a
            valid lodging request.
        '401':
          description: >-
            Returned if the AcceptorId, AccountId, AccountToken and TerminalId
            (config file only) are not provided in the HTTP request header or in
            the config file.
      tags:
        - Authorization
      description: >-
        This increments the original authorization by the given
        transactionAmount. The transactionId is the value returned by the
        original authorization. <a
        href='https://triposcert.vantiv.com/api/help/kb/incrementalAuth.html'>More&raquo;</a>
      operationId: postv1authorizationtransactionIdincremental
      summary: Increases a previous card authorization by the given transactionAmount
  /api/v1/balance:
    post:
      parameters:
        - description: The ID of the business application.
          in: header
          name: tp-application-id
          required: true
          type: string
        - description: The name of the business application.
          in: header
          name: tp-application-name
          required: true
          type: string
        - description: The version of the business application.
          in: header
          name: tp-application-version
          required: true
          type: string
        - description: The authorization header.
          in: header
          name: tp-authorization
          required: true
          type: string
        - description: >-
            The Express acceptorId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-acceptor-id
          required: true
          type: string
        - description: >-
            The Express accountId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-id
          required: true
          type: string
        - description: >-
            The Express accountToken. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-token
          required: true
          type: string
        - description: >-
            A unique ID for this request. This value should be a UUID or GUID.
            <a href='https://triposcert.vantiv.com/api/help/kb/requestid.html'>more&raquo;</a>
          in: header
          name: tp-request-id
          required: true
          type: string
        - description: Set to true to have logs populated in the response.
          in: header
          name: tp-return-logs
          required: false
          type: boolean
        - default: application/json
          description: Content type for request.
          in: header
          name: Content-Type
          required: true
          type: string
        - in: body
          name: BalanceRequest
          required: false
          schema:
            $ref: '#/definitions/POST_BalanceRequest_v1_balance'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/BalanceResponse'
        '401':
          description: >-
            Returned if the AcceptorId, AccountId, AccountToken and TerminalId
            (config file only) are not provided in the HTTP request header or in
            the config file.
      tags:
        - Balance
      operationId: postv1balance
      summary: Requests a balance for a gift/loyalty card
  '/api/v1/barcode/{laneId}':
    get:
      parameters:
        - description: The lane ID.
          format: int32
          in: path
          name: laneId
          required: true
          type: integer
        - description: Sets the Aimer LED lights on/off.
          in: query
          name: aimerLightsOn
          required: false
          type: string
        - description: 'Sets the Image Mode to 1D, 2D, etc.'
          in: query
          name: image
          required: false
          type: string
        - description: Sets the Lighting Mode to a shorter or longer exposure time.
          in: query
          name: lighting
          required: false
          type: string
        - description: The message to be displayed on the PIN pad screen.
          in: query
          name: message
          required: false
          type: string
        - description: Sets the Scan LED lights on/off.
          in: query
          name: scanLightsOn
          required: false
          type: string
        - description: >-
            Sets the amount of time (in seconds) triPOS should wait to receive
            the barcode data
          in: query
          name: timeout
          required: false
          type: string
        - description: Sets the option to use the trigger to start a scan.
          in: query
          name: useTrigger
          required: false
          type: string
        - description: The ID of the business application.
          in: header
          name: tp-application-id
          required: true
          type: string
        - description: The name of the business application.
          in: header
          name: tp-application-name
          required: true
          type: string
        - description: The version of the business application.
          in: header
          name: tp-application-version
          required: true
          type: string
        - description: The authorization header.
          in: header
          name: tp-authorization
          required: true
          type: string
        - description: >-
            The Express acceptorId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-acceptor-id
          required: true
          type: string
        - description: >-
            The Express accountId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-id
          required: true
          type: string
        - description: >-
            The Express accountToken. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-token
          required: true
          type: string
        - description: >-
            A unique ID for this request. This value should be a UUID or GUID.
            <a href='https://triposcert.vantiv.com/api/help/kb/requestid.html'>more&raquo;</a>
          in: header
          name: tp-request-id
          required: true
          type: string
        - description: Set to true to have logs populated in the response.
          in: header
          name: tp-return-logs
          required: false
          type: boolean
        - default: application/json
          description: Content type for request.
          in: header
          name: Content-Type
          required: true
          type: string
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/BarcodeResponse'
      tags:
        - Barcode
      description: >-
        Use the barcode endpoint to initiate and retrieve the data from a
        barcode scan of a capable PIN pad. See <a
        href='https://triposcert.vantiv.com/api/help/kb/barcode.html'>barcode documentation</a> for more
        information.
      operationId: getv1barcodelaneId
      summary: Initiates and retrieves the data from a barcode scan.
  '/api/v1/binQuery/{laneId}':
    get:
      parameters:
        - description: The lane ID.
          format: int32
          in: path
          name: laneId
          required: true
          type: integer
        - description: The flag that invokes manual entry directly.
          in: query
          name: invokeManualEntry
          required: false
          type: boolean
        - description: >-
            Invokes prompt for cardholder to enter card security code for manual
            keyed card entry.
          in: query
          name: isCscSupported
          required: false
          type: string
        - description: The ID of the business application.
          in: header
          name: tp-application-id
          required: true
          type: string
        - description: The name of the business application.
          in: header
          name: tp-application-name
          required: true
          type: string
        - description: The version of the business application.
          in: header
          name: tp-application-version
          required: true
          type: string
        - description: The authorization header.
          in: header
          name: tp-authorization
          required: true
          type: string
        - description: >-
            The Express acceptorId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-acceptor-id
          required: true
          type: string
        - description: >-
            The Express accountId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-id
          required: true
          type: string
        - description: >-
            The Express accountToken. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-token
          required: true
          type: string
        - description: >-
            A unique ID for this request. This value should be a UUID or GUID.
            <a href='https://triposcert.vantiv.com/api/help/kb/requestid.html'>more&raquo;</a>
          in: header
          name: tp-request-id
          required: true
          type: string
        - description: Set to true to have logs populated in the response.
          in: header
          name: tp-return-logs
          required: false
          type: boolean
        - default: application/json
          description: Content type for request.
          in: header
          name: Content-Type
          required: true
          type: string
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/BinQueryResponse'
        '401':
          description: >-
            Returned if the AcceptorId, AccountId, AccountToken and TerminalId
            (config file only) are not provided in the HTTP request header or in
            the config file.
        '404':
          description: Returned if card is not found in the BIN table
      tags:
        - BinQuery
      description: >-
        Use the GET /binQuery/{laneId} endpoint to determine if a card falls
        into a specific BIN range such as prepaid, healthcare, or debit. The BIN
        query endpoint always makes an online call to the host in order to
        ensure the most up-to-date BIN information. If the card swiped or
        inserted is not found in the online BIN table, this endpoint returns a
        404 Not Found HTTP response.
      operationId: getv1binQuerylaneId
      summary: >-
        Determine if a card falls into a specific BIN range such as prepaid,
        healthcare, or debit
  /api/v1/cancel:
    post:
      parameters:
        - description: The ID of the business application.
          in: header
          name: tp-application-id
          required: true
          type: string
        - description: The name of the business application.
          in: header
          name: tp-application-name
          required: true
          type: string
        - description: The version of the business application.
          in: header
          name: tp-application-version
          required: true
          type: string
        - description: The authorization header.
          in: header
          name: tp-authorization
          required: true
          type: string
        - description: >-
            The Express acceptorId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-acceptor-id
          required: true
          type: string
        - description: >-
            The Express accountId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-id
          required: true
          type: string
        - description: >-
            The Express accountToken. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-token
          required: true
          type: string
        - description: >-
            A unique ID for this request. This value should be a UUID or GUID.
            <a href='https://triposcert.vantiv.com/api/help/kb/requestid.html'>more&raquo;</a>
          in: header
          name: tp-request-id
          required: true
          type: string
        - description: Set to true to have logs populated in the response.
          in: header
          name: tp-return-logs
          required: false
          type: boolean
        - default: application/json
          description: Content type for request.
          in: header
          name: Content-Type
          required: true
          type: string
        - in: body
          name: CancelTransactionRequest
          required: false
          schema:
            $ref: '#/definitions/POST_CancelTransactionRequest_v1_cancel'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/CancelTransactionResponse'
        '400':
          description: Returned if the laneId is not valid or the lane is already in use
        '500':
          description: Returned if the PIN pad is disconnected
      tags:
        - Cancel
      description: >-
        Use cancel endpoint to cancel the PreRead transaction. See <a
        href='https://triposcert.vantiv.com/api/help/kb/Cancel.html'>cancel documentation</a> for more
        information.
      operationId: postv1cancel
      summary: Cancel PreRead transaction at the lane level
  /api/v1/card:
    get:
      parameters:
        - description: The ID of the business application.
          in: header
          name: tp-application-id
          required: true
          type: string
        - description: The name of the business application.
          in: header
          name: tp-application-name
          required: true
          type: string
        - description: The version of the business application.
          in: header
          name: tp-application-version
          required: true
          type: string
        - description: The authorization header.
          in: header
          name: tp-authorization
          required: true
          type: string
        - description: >-
            The Express acceptorId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-acceptor-id
          required: true
          type: string
        - description: >-
            The Express accountId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-id
          required: true
          type: string
        - description: >-
            The Express accountToken. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-token
          required: true
          type: string
        - description: >-
            A unique ID for this request. This value should be a UUID or GUID.
            <a href='https://triposcert.vantiv.com/api/help/kb/requestid.html'>more&raquo;</a>
          in: header
          name: tp-request-id
          required: true
          type: string
        - description: Set to true to have logs populated in the response.
          in: header
          name: tp-return-logs
          required: false
          type: boolean
        - default: application/json
          description: Content type for request.
          in: header
          name: Content-Type
          required: true
          type: string
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/CardResponse'
      tags:
        - Card
      operationId: getv1card
      summary: Return a list of the triPOS Card endpoints
  /api/v1/card/financial:
    get:
      parameters:
        - description: The ID of the business application.
          in: header
          name: tp-application-id
          required: true
          type: string
        - description: The name of the business application.
          in: header
          name: tp-application-name
          required: true
          type: string
        - description: The version of the business application.
          in: header
          name: tp-application-version
          required: true
          type: string
        - description: The authorization header.
          in: header
          name: tp-authorization
          required: true
          type: string
        - description: >-
            The Express acceptorId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-acceptor-id
          required: true
          type: string
        - description: >-
            The Express accountId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-id
          required: true
          type: string
        - description: >-
            The Express accountToken. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-token
          required: true
          type: string
        - description: >-
            A unique ID for this request. This value should be a UUID or GUID.
            <a href='https://triposcert.vantiv.com/api/help/kb/requestid.html'>more&raquo;</a>
          in: header
          name: tp-request-id
          required: true
          type: string
        - description: Set to true to have logs populated in the response.
          in: header
          name: tp-return-logs
          required: false
          type: boolean
        - default: application/json
          description: Content type for request.
          in: header
          name: Content-Type
          required: true
          type: string
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/FinancialCardResponse'
      tags:
        - Card
      operationId: getv1cardfinancial
      summary: Return a list of the triPOS FinancialCard endpoints
  '/api/v1/card/financial/{laneId}':
    get:
      parameters:
        - description: The lane ID.
          format: int32
          in: path
          name: laneId
          required: true
          type: integer
        - description: The flag that indicates if encrypted card data needs to be obtained.
          in: query
          name: isEncryptedDataNeeded
          required: false
          type: boolean
        - description: The flag that invokes manual entry directly.
          in: query
          name: invokeManualEntry
          required: false
          type: boolean
        - description: >-
            Invokes prompt for cardholder to enter card security code for manual
            keyed card entry.
          in: query
          name: isCscSupported
          required: false
          type: string
        - description: The ID of the business application.
          in: header
          name: tp-application-id
          required: true
          type: string
        - description: The name of the business application.
          in: header
          name: tp-application-name
          required: true
          type: string
        - description: The version of the business application.
          in: header
          name: tp-application-version
          required: true
          type: string
        - description: The authorization header.
          in: header
          name: tp-authorization
          required: true
          type: string
        - description: >-
            The Express acceptorId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-acceptor-id
          required: true
          type: string
        - description: >-
            The Express accountId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-id
          required: true
          type: string
        - description: >-
            The Express accountToken. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-token
          required: true
          type: string
        - description: >-
            A unique ID for this request. This value should be a UUID or GUID.
            <a href='https://triposcert.vantiv.com/api/help/kb/requestid.html'>more&raquo;</a>
          in: header
          name: tp-request-id
          required: true
          type: string
        - description: Set to true to have logs populated in the response.
          in: header
          name: tp-return-logs
          required: false
          type: boolean
        - default: application/json
          description: Content type for request.
          in: header
          name: Content-Type
          required: true
          type: string
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/FinancialCardResponse'
        '404':
          description: Returned if no financial data can be found when the card is swiped.
      tags:
        - Card
      operationId: getv1cardfinanciallaneId
      summary: Get financial card info
  /api/v1/card/nonfinancial:
    get:
      parameters:
        - description: The ID of the business application.
          in: header
          name: tp-application-id
          required: true
          type: string
        - description: The name of the business application.
          in: header
          name: tp-application-name
          required: true
          type: string
        - description: The version of the business application.
          in: header
          name: tp-application-version
          required: true
          type: string
        - description: The authorization header.
          in: header
          name: tp-authorization
          required: true
          type: string
        - description: >-
            The Express acceptorId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-acceptor-id
          required: true
          type: string
        - description: >-
            The Express accountId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-id
          required: true
          type: string
        - description: >-
            The Express accountToken. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-token
          required: true
          type: string
        - description: >-
            A unique ID for this request. This value should be a UUID or GUID.
            <a href='https://triposcert.vantiv.com/api/help/kb/requestid.html'>more&raquo;</a>
          in: header
          name: tp-request-id
          required: true
          type: string
        - description: Set to true to have logs populated in the response.
          in: header
          name: tp-return-logs
          required: false
          type: boolean
        - default: application/json
          description: Content type for request.
          in: header
          name: Content-Type
          required: true
          type: string
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/NonFinancialCardResponse'
      tags:
        - Card
      operationId: getv1cardnonfinancial
      summary: Return a list of the triPOS NonFinancialCard endpoints
  '/api/v1/card/nonfinancial/{laneId}':
    get:
      parameters:
        - description: The lane ID.
          format: int32
          in: path
          name: laneId
          required: true
          type: integer
        - description: The flag that invokes manual entry directly.
          in: query
          name: invokeManualEntry
          required: false
          type: boolean
        - description: >-
            Invokes prompt for cardholder to enter card security code for manual
            keyed card entry.
          in: query
          name: isCscSupported
          required: false
          type: string
        - description: The ID of the business application.
          in: header
          name: tp-application-id
          required: true
          type: string
        - description: The name of the business application.
          in: header
          name: tp-application-name
          required: true
          type: string
        - description: The version of the business application.
          in: header
          name: tp-application-version
          required: true
          type: string
        - description: The authorization header.
          in: header
          name: tp-authorization
          required: true
          type: string
        - description: >-
            The Express acceptorId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-acceptor-id
          required: true
          type: string
        - description: >-
            The Express accountId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-id
          required: true
          type: string
        - description: >-
            The Express accountToken. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-token
          required: true
          type: string
        - description: >-
            A unique ID for this request. This value should be a UUID or GUID.
            <a href='https://triposcert.vantiv.com/api/help/kb/requestid.html'>more&raquo;</a>
          in: header
          name: tp-request-id
          required: true
          type: string
        - description: Set to true to have logs populated in the response.
          in: header
          name: tp-return-logs
          required: false
          type: boolean
        - default: application/json
          description: Content type for request.
          in: header
          name: Content-Type
          required: true
          type: string
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/NonFinancialCardResponse'
        '404':
          description: >-
            If no 'non-financial' data can be found when the card is swiped,
            tripos returns an HTTP status code of 404.
      tags:
        - Card
      operationId: getv1cardnonfinanciallaneId
      summary: Get non-financial card info
  '/api/v1/card/{laneId}':
    get:
      parameters:
        - description: The lane ID.
          format: int32
          in: path
          name: laneId
          required: true
          type: integer
        - description: The flag that indicates if encrypted card data needs to be obtained.
          in: query
          name: isEncryptedDataNeeded
          required: false
          type: boolean
        - description: The flag that invokes manual entry directly.
          in: query
          name: invokeManualEntry
          required: false
          type: boolean
        - description: >-
            Invokes prompt for cardholder to enter card security code for manual
            keyed card entry.
          in: query
          name: isCscSupported
          required: false
          type: string
        - description: The ID of the business application.
          in: header
          name: tp-application-id
          required: true
          type: string
        - description: The name of the business application.
          in: header
          name: tp-application-name
          required: true
          type: string
        - description: The version of the business application.
          in: header
          name: tp-application-version
          required: true
          type: string
        - description: The authorization header.
          in: header
          name: tp-authorization
          required: true
          type: string
        - description: >-
            The Express acceptorId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-acceptor-id
          required: true
          type: string
        - description: >-
            The Express accountId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-id
          required: true
          type: string
        - description: >-
            The Express accountToken. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-token
          required: true
          type: string
        - description: >-
            A unique ID for this request. This value should be a UUID or GUID.
            <a href='https://triposcert.vantiv.com/api/help/kb/requestid.html'>more&raquo;</a>
          in: header
          name: tp-request-id
          required: true
          type: string
        - description: Set to true to have logs populated in the response.
          in: header
          name: tp-return-logs
          required: false
          type: boolean
        - default: application/json
          description: Content type for request.
          in: header
          name: Content-Type
          required: true
          type: string
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/CardResponse'
        '404':
          description: >-
            If no data can be found when the card is swiped, tripos returns an
            HTTP status code of 404.
      tags:
        - Card
      operationId: getv1cardlaneId
      summary: Get card info
  /api/v1/credit:
    post:
      parameters:
        - description: >-
            The action to perform with the refund. This can either be 'store' or
            'forward'. More information on <a
            href='https://triposcert.vantiv.com/api/help/kb/storeForward.html'>Store and Forward</a> here.
          in: query
          name: action
          required: false
          type: string
        - description: The request ID of the stored transaction to forward.
          in: query
          name: requestIdToForward
          required: false
          type: string
        - description: The ID of the business application.
          in: header
          name: tp-application-id
          required: true
          type: string
        - description: The name of the business application.
          in: header
          name: tp-application-name
          required: true
          type: string
        - description: The version of the business application.
          in: header
          name: tp-application-version
          required: true
          type: string
        - description: The authorization header.
          in: header
          name: tp-authorization
          required: true
          type: string
        - description: >-
            The Express acceptorId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-acceptor-id
          required: true
          type: string
        - description: >-
            The Express accountId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-id
          required: true
          type: string
        - description: >-
            The Express accountToken. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-token
          required: true
          type: string
        - description: >-
            A unique ID for this request. This value should be a UUID or GUID.
            <a href='https://triposcert.vantiv.com/api/help/kb/requestid.html'>more&raquo;</a>
          in: header
          name: tp-request-id
          required: true
          type: string
        - description: Set to true to have logs populated in the response.
          in: header
          name: tp-return-logs
          required: false
          type: boolean
        - default: application/json
          description: Content type for request.
          in: header
          name: Content-Type
          required: true
          type: string
        - in: body
          name: RefundRequest
          required: false
          schema:
            $ref: '#/definitions/POST_RefundRequest_v1_credit'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/RefundResponse'
        '401':
          description: >-
            Returned if the AcceptorId, AccountId, AccountToken and TerminalId
            (config file only) are not provided in the HTTP request header or in
            the config file.
      tags:
        - Credit
      operationId: postv1credit
      summary: '[Deprecated] Use /v1/refund instead'
  /api/v1/display:
    post:
      parameters:
        - description: The ID of the business application.
          in: header
          name: tp-application-id
          required: true
          type: string
        - description: The name of the business application.
          in: header
          name: tp-application-name
          required: true
          type: string
        - description: The version of the business application.
          in: header
          name: tp-application-version
          required: true
          type: string
        - description: The authorization header.
          in: header
          name: tp-authorization
          required: true
          type: string
        - description: >-
            The Express acceptorId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-acceptor-id
          required: true
          type: string
        - description: >-
            The Express accountId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-id
          required: true
          type: string
        - description: >-
            The Express accountToken. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-token
          required: true
          type: string
        - description: >-
            A unique ID for this request. This value should be a UUID or GUID.
            <a href='https://triposcert.vantiv.com/api/help/kb/requestid.html'>more&raquo;</a>
          in: header
          name: tp-request-id
          required: true
          type: string
        - description: Set to true to have logs populated in the response.
          in: header
          name: tp-return-logs
          required: false
          type: boolean
        - default: application/json
          description: Content type for request.
          in: header
          name: Content-Type
          required: true
          type: string
        - in: body
          name: DisplayRequest
          required: false
          schema:
            $ref: '#/definitions/POST_DisplayRequest_v1_display'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/DisplayResponse'
        '400':
          description: Returned if parameter values are missing or invalid.
      tags:
        - Display
      description: >-
        Use the display endpoint to display a text on the PIN pad. This endpoint
        returns an HTTP status code of 200 if the text was successfully
        displayed on the PIN pad. See <a href='https://triposcert.vantiv.com/api/help/kb/display.html'>display
        documentation</a> fore more information.
      operationId: postv1display
      summary: Displays a text on the PIN pad.
  /api/v1/ebtVoucher:
    post:
      parameters:
        - description: The ID of the business application.
          in: header
          name: tp-application-id
          required: true
          type: string
        - description: The name of the business application.
          in: header
          name: tp-application-name
          required: true
          type: string
        - description: The version of the business application.
          in: header
          name: tp-application-version
          required: true
          type: string
        - description: The authorization header.
          in: header
          name: tp-authorization
          required: true
          type: string
        - description: >-
            The Express acceptorId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-acceptor-id
          required: true
          type: string
        - description: >-
            The Express accountId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-id
          required: true
          type: string
        - description: >-
            The Express accountToken. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-token
          required: true
          type: string
        - description: >-
            A unique ID for this request. This value should be a UUID or GUID.
            <a href='https://triposcert.vantiv.com/api/help/kb/requestid.html'>more&raquo;</a>
          in: header
          name: tp-request-id
          required: true
          type: string
        - description: Set to true to have logs populated in the response.
          in: header
          name: tp-return-logs
          required: false
          type: boolean
        - default: application/json
          description: Content type for request.
          in: header
          name: Content-Type
          required: true
          type: string
        - in: body
          name: EbtVoucherRequest
          required: false
          schema:
            $ref: '#/definitions/POST_EbtVoucherRequest_v1_ebtVoucher'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/EbtVoucherResponse'
        '400':
          description: >-
            Returned if the transaction amount is less than 0 on a valid
            request.
        '401':
          description: >-
            Returned if the AcceptorId, AccountId, AccountToken and TerminalId
            (config file only) are not provided in the HTTP request header or in
            the config file.
        '404':
          description: Returned if the laneId is not valid.
        '500':
          description: Returned if the PIN pad is disconnected or lane is already in use.
      tags:
        - EbtVoucher
      operationId: postv1ebtVoucher
      summary: Creates a new EBT voucher sale based on the passed in amount
  /api/v1/force:
    get:
      parameters:
        - description: The ID of the business application.
          in: header
          name: tp-application-id
          required: true
          type: string
        - description: The name of the business application.
          in: header
          name: tp-application-name
          required: true
          type: string
        - description: The version of the business application.
          in: header
          name: tp-application-version
          required: true
          type: string
        - description: The authorization header.
          in: header
          name: tp-authorization
          required: true
          type: string
        - description: >-
            The Express acceptorId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-acceptor-id
          required: true
          type: string
        - description: >-
            The Express accountId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-id
          required: true
          type: string
        - description: >-
            The Express accountToken. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-token
          required: true
          type: string
        - description: >-
            A unique ID for this request. This value should be a UUID or GUID.
            <a href='https://triposcert.vantiv.com/api/help/kb/requestid.html'>more&raquo;</a>
          in: header
          name: tp-request-id
          required: true
          type: string
        - description: Set to true to have logs populated in the response.
          in: header
          name: tp-return-logs
          required: false
          type: boolean
        - default: application/json
          description: Content type for request.
          in: header
          name: Content-Type
          required: true
          type: string
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/ForceResponse'
      tags:
        - Force
      operationId: getv1force
      summary: Returns a the list of force endpoints
  /api/v1/force/credit:
    post:
      parameters:
        - description: The ID of the business application.
          in: header
          name: tp-application-id
          required: true
          type: string
        - description: The name of the business application.
          in: header
          name: tp-application-name
          required: true
          type: string
        - description: The version of the business application.
          in: header
          name: tp-application-version
          required: true
          type: string
        - description: The authorization header.
          in: header
          name: tp-authorization
          required: true
          type: string
        - description: >-
            The Express acceptorId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-acceptor-id
          required: true
          type: string
        - description: >-
            The Express accountId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-id
          required: true
          type: string
        - description: >-
            The Express accountToken. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-token
          required: true
          type: string
        - description: >-
            A unique ID for this request. This value should be a UUID or GUID.
            <a href='https://triposcert.vantiv.com/api/help/kb/requestid.html'>more&raquo;</a>
          in: header
          name: tp-request-id
          required: true
          type: string
        - description: Set to true to have logs populated in the response.
          in: header
          name: tp-return-logs
          required: false
          type: boolean
        - default: application/json
          description: Content type for request.
          in: header
          name: Content-Type
          required: true
          type: string
        - in: body
          name: ForceCreditRequest
          required: false
          schema:
            $ref: '#/definitions/POST_ForceCreditRequest_v1_force_credit'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/CreditCardForceResponse'
        '400':
          description: >-
            1) Returned if MarketCode is not HotelLodging but the request
            includes lodging parameters on a valid lodging request. 2) Returned
            if the lodging checkInDate or checkOutDate is not in the ISO 8601
            format of YYYY-MM-DD on a valid lodging request. 3) Returned if the
            lodging roomAmount is less than 0.00 on a valid lodging request. 4)
            Returned if the lodging duration is less than 0 on a valid lodging
            request.
        '401':
          description: >-
            Returned if the AcceptorId, AccountId, AccountToken and TerminalId
            (config file only) are not provided in the HTTP request header or in
            the config file.
      tags:
        - Force
      description: >-
        This endpoint supports QuickChip/PreRead functionality. See <a
        href='https://triposcert.vantiv.com/api/help/kb/cloud/QuickChipConfiguration.html'> QuickChip/PreRead
        documentation</a> for more information.
      operationId: postv1forcecredit
      summary: Creates a new credit card force based on the passed in amounts
  /api/v1/gift:
    get:
      parameters:
        - description: The ID of the business application.
          in: header
          name: tp-application-id
          required: true
          type: string
        - description: The name of the business application.
          in: header
          name: tp-application-name
          required: true
          type: string
        - description: The version of the business application.
          in: header
          name: tp-application-version
          required: true
          type: string
        - description: The authorization header.
          in: header
          name: tp-authorization
          required: true
          type: string
        - description: >-
            The Express acceptorId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-acceptor-id
          required: true
          type: string
        - description: >-
            The Express accountId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-id
          required: true
          type: string
        - description: >-
            The Express accountToken. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-token
          required: true
          type: string
        - description: >-
            A unique ID for this request. This value should be a UUID or GUID.
            <a href='https://triposcert.vantiv.com/api/help/kb/requestid.html'>more&raquo;</a>
          in: header
          name: tp-request-id
          required: true
          type: string
        - description: Set to true to have logs populated in the response.
          in: header
          name: tp-return-logs
          required: false
          type: boolean
        - default: application/json
          description: Content type for request.
          in: header
          name: Content-Type
          required: true
          type: string
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/GiftResponse'
      tags:
        - Gift
      operationId: getv1gift
      summary: Return the endpoints used to manage Vantiv & Valutec Gift Cards
  /api/v1/gift/activate:
    post:
      parameters:
        - description: The ID of the business application.
          in: header
          name: tp-application-id
          required: true
          type: string
        - description: The name of the business application.
          in: header
          name: tp-application-name
          required: true
          type: string
        - description: The version of the business application.
          in: header
          name: tp-application-version
          required: true
          type: string
        - description: The authorization header.
          in: header
          name: tp-authorization
          required: true
          type: string
        - description: >-
            The Express acceptorId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-acceptor-id
          required: true
          type: string
        - description: >-
            The Express accountId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-id
          required: true
          type: string
        - description: >-
            The Express accountToken. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-token
          required: true
          type: string
        - description: >-
            A unique ID for this request. This value should be a UUID or GUID.
            <a href='https://triposcert.vantiv.com/api/help/kb/requestid.html'>more&raquo;</a>
          in: header
          name: tp-request-id
          required: true
          type: string
        - description: Set to true to have logs populated in the response.
          in: header
          name: tp-return-logs
          required: false
          type: boolean
        - default: application/json
          description: Content type for request.
          in: header
          name: Content-Type
          required: true
          type: string
        - in: body
          name: ActivateGiftRequest
          required: false
          schema:
            $ref: '#/definitions/POST_ActivateGiftRequest_v1_gift_activate'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/ActivateGiftResponse'
      tags:
        - Gift
      operationId: postv1giftactivate
      summary: Activates the given gift/loyalty card with the specified amount
  /api/v1/gift/balanceTransfer:
    post:
      parameters:
        - description: The ID of the business application.
          in: header
          name: tp-application-id
          required: true
          type: string
        - description: The name of the business application.
          in: header
          name: tp-application-name
          required: true
          type: string
        - description: The version of the business application.
          in: header
          name: tp-application-version
          required: true
          type: string
        - description: The authorization header.
          in: header
          name: tp-authorization
          required: true
          type: string
        - description: >-
            The Express acceptorId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-acceptor-id
          required: true
          type: string
        - description: >-
            The Express accountId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-id
          required: true
          type: string
        - description: >-
            The Express accountToken. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-token
          required: true
          type: string
        - description: >-
            A unique ID for this request. This value should be a UUID or GUID.
            <a href='https://triposcert.vantiv.com/api/help/kb/requestid.html'>more&raquo;</a>
          in: header
          name: tp-request-id
          required: true
          type: string
        - description: Set to true to have logs populated in the response.
          in: header
          name: tp-return-logs
          required: false
          type: boolean
        - default: application/json
          description: Content type for request.
          in: header
          name: Content-Type
          required: true
          type: string
        - in: body
          name: BalanceTransferGiftRequest
          required: false
          schema:
            $ref: >-
              #/definitions/POST_BalanceTransferGiftRequest_v1_gift_balanceTransfer
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/BalanceTransferGiftResponse'
        '400':
          description: >-
            Returned if all the alternate card number fields are missing or
            empty.
      tags:
        - Gift
      description: >-
        Notes for the Valutec Gift program:<br> • Only one source (From) card
        can be used (AlternateCardNumber1).<br> • Source (From) card must be
        Active, and Destination (To) card must be Inactive. Upon a successful
        GiftCardBalanceTransfer request, the From card will automatically be
        Deactivated, and the To card will automatically be Activated.<br> Notes
        for the Vantiv Core Gift program:<br> • Up to three source (From) cards
        can be used.<br> • Source (From) cards must be Active, but Destination
        (To) cards may be Active or Inactive. Upon a successful
        GiftCardBalanceTransfer request, the From cards will automatically be
        Deactivated, and the To card will automatically be Activated (if not
        already previously Active).
      operationId: postv1giftbalanceTransfer
      summary: Transfer funds from one card to another
  /api/v1/gift/close:
    post:
      parameters:
        - description: The ID of the business application.
          in: header
          name: tp-application-id
          required: true
          type: string
        - description: The name of the business application.
          in: header
          name: tp-application-name
          required: true
          type: string
        - description: The version of the business application.
          in: header
          name: tp-application-version
          required: true
          type: string
        - description: The authorization header.
          in: header
          name: tp-authorization
          required: true
          type: string
        - description: >-
            The Express acceptorId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-acceptor-id
          required: true
          type: string
        - description: >-
            The Express accountId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-id
          required: true
          type: string
        - description: >-
            The Express accountToken. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-token
          required: true
          type: string
        - description: >-
            A unique ID for this request. This value should be a UUID or GUID.
            <a href='https://triposcert.vantiv.com/api/help/kb/requestid.html'>more&raquo;</a>
          in: header
          name: tp-request-id
          required: true
          type: string
        - description: Set to true to have logs populated in the response.
          in: header
          name: tp-return-logs
          required: false
          type: boolean
        - default: application/json
          description: Content type for request.
          in: header
          name: Content-Type
          required: true
          type: string
        - in: body
          name: CloseGiftRequest
          required: false
          schema:
            $ref: '#/definitions/POST_CloseGiftRequest_v1_gift_close'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/CloseGiftResponse'
      tags:
        - Gift
      description: >-
        This is used to close an active Valutec gift/loyalty card and reduce its
        balance to $0.  Close may be used to either close a card due to
        fraudulent use, or, if the customer demands a refund, it may be used to
        provide a full cash refund of the remaining balance on the card.  Once
        this close request is complete, the gift/loyalty card number is closed
        and can no longer be used (i.e. cannot be re-activated).
      operationId: postv1giftclose
      summary: Close a Valutec gift/loyalty card
  /api/v1/gift/reload:
    post:
      parameters:
        - description: The ID of the business application.
          in: header
          name: tp-application-id
          required: true
          type: string
        - description: The name of the business application.
          in: header
          name: tp-application-name
          required: true
          type: string
        - description: The version of the business application.
          in: header
          name: tp-application-version
          required: true
          type: string
        - description: The authorization header.
          in: header
          name: tp-authorization
          required: true
          type: string
        - description: >-
            The Express acceptorId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-acceptor-id
          required: true
          type: string
        - description: >-
            The Express accountId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-id
          required: true
          type: string
        - description: >-
            The Express accountToken. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-token
          required: true
          type: string
        - description: >-
            A unique ID for this request. This value should be a UUID or GUID.
            <a href='https://triposcert.vantiv.com/api/help/kb/requestid.html'>more&raquo;</a>
          in: header
          name: tp-request-id
          required: true
          type: string
        - description: Set to true to have logs populated in the response.
          in: header
          name: tp-return-logs
          required: false
          type: boolean
        - default: application/json
          description: Content type for request.
          in: header
          name: Content-Type
          required: true
          type: string
        - in: body
          name: ReloadGiftRequest
          required: false
          schema:
            $ref: '#/definitions/POST_ReloadGiftRequest_v1_gift_reload'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/ReloadGiftResponse'
      tags:
        - Gift
      operationId: postv1giftreload
      summary: Reloads the given gift/loyalty card with the specified amount
  /api/v1/gift/unload:
    post:
      parameters:
        - description: The ID of the business application.
          in: header
          name: tp-application-id
          required: true
          type: string
        - description: The name of the business application.
          in: header
          name: tp-application-name
          required: true
          type: string
        - description: The version of the business application.
          in: header
          name: tp-application-version
          required: true
          type: string
        - description: The authorization header.
          in: header
          name: tp-authorization
          required: true
          type: string
        - description: >-
            The Express acceptorId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-acceptor-id
          required: true
          type: string
        - description: >-
            The Express accountId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-id
          required: true
          type: string
        - description: >-
            The Express accountToken. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-token
          required: true
          type: string
        - description: >-
            A unique ID for this request. This value should be a UUID or GUID.
            <a href='https://triposcert.vantiv.com/api/help/kb/requestid.html'>more&raquo;</a>
          in: header
          name: tp-request-id
          required: true
          type: string
        - description: Set to true to have logs populated in the response.
          in: header
          name: tp-return-logs
          required: false
          type: boolean
        - default: application/json
          description: Content type for request.
          in: header
          name: Content-Type
          required: true
          type: string
        - in: body
          name: UnloadGiftRequest
          required: false
          schema:
            $ref: '#/definitions/POST_UnloadGiftRequest_v1_gift_unload'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/UnloadGiftResponse'
      tags:
        - Gift
      description: >-
        This is used to remove funds from an existing active Valutec gift card. 
        The Unload is typically associated with a payment transaction at the POS
        register when the merchant wishes to decrease the balance of the card
        due to a cash.  This method could also be used to adjust the balance due
        to a processing or customer service issue.  This method will result in
        the card being deactivated, though the card can be re-activated and used
        again.
      operationId: postv1giftunload
      summary: Remove funds from a Valutec gift card
  /api/v1/idle:
    post:
      parameters:
        - description: The ID of the business application.
          in: header
          name: tp-application-id
          required: true
          type: string
        - description: The name of the business application.
          in: header
          name: tp-application-name
          required: true
          type: string
        - description: The version of the business application.
          in: header
          name: tp-application-version
          required: true
          type: string
        - description: The authorization header.
          in: header
          name: tp-authorization
          required: true
          type: string
        - description: >-
            The Express acceptorId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-acceptor-id
          required: true
          type: string
        - description: >-
            The Express accountId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-id
          required: true
          type: string
        - description: >-
            The Express accountToken. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-token
          required: true
          type: string
        - description: >-
            A unique ID for this request. This value should be a UUID or GUID.
            <a href='https://triposcert.vantiv.com/api/help/kb/requestid.html'>more&raquo;</a>
          in: header
          name: tp-request-id
          required: true
          type: string
        - description: Set to true to have logs populated in the response.
          in: header
          name: tp-return-logs
          required: false
          type: boolean
        - default: application/json
          description: Content type for request.
          in: header
          name: Content-Type
          required: true
          type: string
        - in: body
          name: IdleRequest
          required: false
          schema:
            $ref: '#/definitions/POST_IdleRequest_v1_idle'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/IdleResponse'
        '400':
          description: Returned if the laneId is not valid or the lane is already in use
        '500':
          description: Returned if the PIN pad is disconnected
      tags:
        - Idle
      description: "Use the idle endpoint to return the PIN pad to the idle screen. See <a href='https://triposcert.vantiv.com/api/help/kb/idle.html'>idle documentation</a> for more information.<br><b>DO NOT</b> use as a regular-interval\_health status check."
      operationId: postv1idle
      summary: Displays the idle screen on the specified PIN pad.
  '/api/v1/input/{laneId}':
    get:
      parameters:
        - description: The lane ID.
          in: path
          name: laneId
          required: true
          type: string
        - description: >-
            The type of prompt to display on the PIN pad. <a
            href='https://triposcert.vantiv.com/api/help/kb/input.html'>more&raquo;</a>
          in: query
          name: promptType
          required: true
          type: string
        - description: >-
            The PIN pad uses this format to display the input on the PIN pad as
            the cardholder enters it. <a
            href='https://triposcert.vantiv.com/api/help/kb/input.html'>more&raquo;</a>
          in: query
          name: formatType
          required: false
          type: string
        - description: The ID of the business application.
          in: header
          name: tp-application-id
          required: true
          type: string
        - description: The name of the business application.
          in: header
          name: tp-application-name
          required: true
          type: string
        - description: The version of the business application.
          in: header
          name: tp-application-version
          required: true
          type: string
        - description: The authorization header.
          in: header
          name: tp-authorization
          required: true
          type: string
        - description: >-
            The Express acceptorId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-acceptor-id
          required: true
          type: string
        - description: >-
            The Express accountId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-id
          required: true
          type: string
        - description: >-
            The Express accountToken. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-token
          required: true
          type: string
        - description: >-
            A unique ID for this request. This value should be a UUID or GUID.
            <a href='https://triposcert.vantiv.com/api/help/kb/requestid.html'>more&raquo;</a>
          in: header
          name: tp-request-id
          required: true
          type: string
        - description: Set to true to have logs populated in the response.
          in: header
          name: tp-return-logs
          required: false
          type: boolean
        - default: application/json
          description: Content type for request.
          in: header
          name: Content-Type
          required: true
          type: string
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/InputResponse'
        '400':
          description: Returned if parameter values are missing or invalid.
        '500':
          description: >-
            Returned if the cardholder allows the PIN pad to time out before
            submitting input.
      tags:
        - Input
      description: >-
        Use the input endpoint to prompt the cardholder for input. This endpoint
        returns an HTTP status code of 200 if the cardholder pressed the ok or
        cancel button. See <a href='https://triposcert.vantiv.com/api/help/kb/input.html'>input
        documentation</a> for more information.
      operationId: getv1inputlaneId
      summary: >-
        Displays the prompt associated to the promptType and accepts input text
        from the card holder
  /api/v1/paymentAccount:
    post:
      parameters:
        - description: The ID of the business application.
          in: header
          name: tp-application-id
          required: true
          type: string
        - description: The name of the business application.
          in: header
          name: tp-application-name
          required: true
          type: string
        - description: The version of the business application.
          in: header
          name: tp-application-version
          required: true
          type: string
        - description: The authorization header.
          in: header
          name: tp-authorization
          required: true
          type: string
        - description: >-
            The Express acceptorId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-acceptor-id
          required: true
          type: string
        - description: >-
            The Express accountId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-id
          required: true
          type: string
        - description: >-
            The Express accountToken. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-token
          required: true
          type: string
        - description: >-
            A unique ID for this request. This value should be a UUID or GUID.
            <a href='https://triposcert.vantiv.com/api/help/kb/requestid.html'>more&raquo;</a>
          in: header
          name: tp-request-id
          required: true
          type: string
        - description: Set to true to have logs populated in the response.
          in: header
          name: tp-return-logs
          required: false
          type: boolean
        - default: application/json
          description: Content type for request.
          in: header
          name: Content-Type
          required: true
          type: string
        - in: body
          name: CreatePaymentAccountCreditRequest
          required: false
          schema:
            $ref: >-
              #/definitions/POST_CreatePaymentAccountCreditRequest_v1_paymentAccount
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/CreatePaymentAccountCreditResponse'
        '401':
          description: >-
            Returned if the AcceptorId, AccountId, AccountToken and TerminalId
            (config file only) are not provided in the HTTP request header or in
            the config file.
      tags:
        - PaymentAccount
      operationId: postv1paymentAccount
      summary: Creates a card account token based on the given data
  /api/v1/paymentAccount/credit:
    post:
      parameters:
        - description: The ID of the business application.
          in: header
          name: tp-application-id
          required: true
          type: string
        - description: The name of the business application.
          in: header
          name: tp-application-name
          required: true
          type: string
        - description: The version of the business application.
          in: header
          name: tp-application-version
          required: true
          type: string
        - description: The authorization header.
          in: header
          name: tp-authorization
          required: true
          type: string
        - description: >-
            The Express acceptorId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-acceptor-id
          required: true
          type: string
        - description: >-
            The Express accountId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-id
          required: true
          type: string
        - description: >-
            The Express accountToken. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-token
          required: true
          type: string
        - description: >-
            A unique ID for this request. This value should be a UUID or GUID.
            <a href='https://triposcert.vantiv.com/api/help/kb/requestid.html'>more&raquo;</a>
          in: header
          name: tp-request-id
          required: true
          type: string
        - description: Set to true to have logs populated in the response.
          in: header
          name: tp-return-logs
          required: false
          type: boolean
        - default: application/json
          description: Content type for request.
          in: header
          name: Content-Type
          required: true
          type: string
        - in: body
          name: CreatePaymentAccountCreditRequest
          required: false
          schema:
            $ref: >-
              #/definitions/POST_CreatePaymentAccountCreditRequest_v1_paymentAccount_credit
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/CreatePaymentAccountCreditResponse'
        '401':
          description: >-
            Returned if the AcceptorId, AccountId, AccountToken and TerminalId
            (config file only) are not provided in the HTTP request header or in
            the config file.
      tags:
        - PaymentAccount
      operationId: postv1paymentAccountcredit
      summary: '[Deprecated] Use /v1/paymentAccount instead'
  '/api/v1/paymentAccount/{paymentAccountId}':
    delete:
      parameters:
        - description: The payment account ID to update.
          in: path
          name: paymentAccountId
          required: true
          type: string
        - description: The ID of the business application.
          in: header
          name: tp-application-id
          required: true
          type: string
        - description: The name of the business application.
          in: header
          name: tp-application-name
          required: true
          type: string
        - description: The version of the business application.
          in: header
          name: tp-application-version
          required: true
          type: string
        - description: The authorization header.
          in: header
          name: tp-authorization
          required: true
          type: string
        - description: >-
            The Express acceptorId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-acceptor-id
          required: true
          type: string
        - description: >-
            The Express accountId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-id
          required: true
          type: string
        - description: >-
            The Express accountToken. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-token
          required: true
          type: string
        - description: >-
            A unique ID for this request. This value should be a UUID or GUID.
            <a href='https://triposcert.vantiv.com/api/help/kb/requestid.html'>more&raquo;</a>
          in: header
          name: tp-request-id
          required: true
          type: string
        - description: Set to true to have logs populated in the response.
          in: header
          name: tp-return-logs
          required: false
          type: boolean
        - default: application/json
          description: Content type for request.
          in: header
          name: Content-Type
          required: true
          type: string
        - in: body
          name: DeletePaymentAccountRequest
          required: false
          schema:
            $ref: >-
              #/definitions/DELETE_DeletePaymentAccountRequest_v1_paymentAccount_paymentAccountId
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/DeletePaymentAccountResponse'
        '401':
          description: >-
            Returned if the AcceptorId, AccountId, AccountToken and TerminalId
            (config file only) are not provided in the HTTP request header or in
            the config file.
        '404':
          description: >-
            The payment account ID could not be found. No action taken, tripos
            returns an HTTP status code of 404.
      tags:
        - PaymentAccount
      description: >-
        This endpoint deletes a payment account created with POST
        /api/v1/paymentAccount. This endpoint returns an HTTP status code of 200
        if the payment account was successfully deleted. Other HTTP status code
        responses indicate failure. If the payment account is not found, an HTTP
        status code 404 is returned. After a successful delete, this endpoint
        will continue to return HTTP status code 200 until the Express
        processing platform purges the payment account from the system. Payment
        account purge typically happens within 48 hours. After 48 hours, this
        endpoint will return a 404 Not Found HTTP status code for the deleted
        payment account.
      operationId: deletev1paymentAccountpaymentAccountId
      summary: Marks the given payment account for deletion
    put:
      parameters:
        - description: The payment account ID to update.
          in: path
          name: paymentAccountId
          required: true
          type: string
        - description: The ID of the business application.
          in: header
          name: tp-application-id
          required: true
          type: string
        - description: The name of the business application.
          in: header
          name: tp-application-name
          required: true
          type: string
        - description: The version of the business application.
          in: header
          name: tp-application-version
          required: true
          type: string
        - description: The authorization header.
          in: header
          name: tp-authorization
          required: true
          type: string
        - description: >-
            The Express acceptorId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-acceptor-id
          required: true
          type: string
        - description: >-
            The Express accountId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-id
          required: true
          type: string
        - description: >-
            The Express accountToken. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-token
          required: true
          type: string
        - description: >-
            A unique ID for this request. This value should be a UUID or GUID.
            <a href='https://triposcert.vantiv.com/api/help/kb/requestid.html'>more&raquo;</a>
          in: header
          name: tp-request-id
          required: true
          type: string
        - description: Set to true to have logs populated in the response.
          in: header
          name: tp-return-logs
          required: false
          type: boolean
        - default: application/json
          description: Content type for request.
          in: header
          name: Content-Type
          required: true
          type: string
        - in: body
          name: UpdatePaymentAccountCreditRequest
          required: false
          schema:
            $ref: >-
              #/definitions/PUT_UpdatePaymentAccountCreditRequest_v1_paymentAccount_paymentAccountId
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/UpdatePaymentAccountCreditResponse'
        '401':
          description: >-
            Returned if the AcceptorId, AccountId, AccountToken and TerminalId
            (config file only) are not provided in the HTTP request header or in
            the config file.
      tags:
        - PaymentAccount
      operationId: putv1paymentAccountpaymentAccountId
      summary: Updates a payment account based on the given data
  '/api/v1/paymentAccount/{paymentAccountId}/credit':
    put:
      parameters:
        - description: The payment account ID to update.
          in: path
          name: paymentAccountId
          required: true
          type: string
        - description: The ID of the business application.
          in: header
          name: tp-application-id
          required: true
          type: string
        - description: The name of the business application.
          in: header
          name: tp-application-name
          required: true
          type: string
        - description: The version of the business application.
          in: header
          name: tp-application-version
          required: true
          type: string
        - description: The authorization header.
          in: header
          name: tp-authorization
          required: true
          type: string
        - description: >-
            The Express acceptorId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-acceptor-id
          required: true
          type: string
        - description: >-
            The Express accountId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-id
          required: true
          type: string
        - description: >-
            The Express accountToken. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-token
          required: true
          type: string
        - description: >-
            A unique ID for this request. This value should be a UUID or GUID.
            <a href='https://triposcert.vantiv.com/api/help/kb/requestid.html'>more&raquo;</a>
          in: header
          name: tp-request-id
          required: true
          type: string
        - description: Set to true to have logs populated in the response.
          in: header
          name: tp-return-logs
          required: false
          type: boolean
        - default: application/json
          description: Content type for request.
          in: header
          name: Content-Type
          required: true
          type: string
        - in: body
          name: UpdatePaymentAccountCreditRequest
          required: false
          schema:
            $ref: >-
              #/definitions/PUT_UpdatePaymentAccountCreditRequest_v1_paymentAccount_paymentAccountId_credit
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/UpdatePaymentAccountCreditResponse'
        '401':
          description: >-
            Returned if the AcceptorId, AccountId, AccountToken and TerminalId
            (config file only) are not provided in the HTTP request header or in
            the config file.
      tags:
        - PaymentAccount
      operationId: putv1paymentAccountpaymentAccountIdcredit
      summary: '[Deprecated] Use /v1/paymentAccount/{paymentAccountId} instead'
  /api/v1/pinPadSelectionPrompt:
    get:
      parameters:
        - description: The lane ID.
          in: query
          name: laneId
          required: true
          type: string
        - description: The text to display to the cardholder.
          in: query
          name: promptText
          required: false
          type: string
        - description: The list of individual lines of text to be displayed on the PIN pad.
          in: query
          name: multiLinePromptText
          required: false
          type: string
        - description: >-
            The options to provide to the cardholder. Separate each option with
            a pipe '|' (e.g. options=one|two|three)
          in: query
          name: options
          required: true
          type: string
        - description: The ID of the business application.
          in: header
          name: tp-application-id
          required: true
          type: string
        - description: The name of the business application.
          in: header
          name: tp-application-name
          required: true
          type: string
        - description: The version of the business application.
          in: header
          name: tp-application-version
          required: true
          type: string
        - description: The authorization header.
          in: header
          name: tp-authorization
          required: true
          type: string
        - description: >-
            The Express acceptorId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-acceptor-id
          required: true
          type: string
        - description: >-
            The Express accountId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-id
          required: true
          type: string
        - description: >-
            The Express accountToken. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-token
          required: true
          type: string
        - description: >-
            A unique ID for this request. This value should be a UUID or GUID.
            <a href='https://triposcert.vantiv.com/api/help/kb/requestid.html'>more&raquo;</a>
          in: header
          name: tp-request-id
          required: true
          type: string
        - description: Set to true to have logs populated in the response.
          in: header
          name: tp-return-logs
          required: false
          type: boolean
        - default: application/json
          description: Content type for request.
          in: header
          name: Content-Type
          required: true
          type: string
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/PinPadSelectionResponse'
        '500':
          description: >-
            Returned if the cardholder doesn't respond within the specified
            amount of time.
      tags:
        - PinPadSelectionPrompt
      operationId: getv1pinPadSelectionPrompt
      summary: >-
        [Deprecated] Displays a custom PIN pad prompt with custom selection
        options
  /api/v1/pinpad/card:
    get:
      parameters:
        - description: The ID of the business application.
          in: header
          name: tp-application-id
          required: true
          type: string
        - description: The name of the business application.
          in: header
          name: tp-application-name
          required: true
          type: string
        - description: The version of the business application.
          in: header
          name: tp-application-version
          required: true
          type: string
        - description: The authorization header.
          in: header
          name: tp-authorization
          required: true
          type: string
        - description: >-
            The Express acceptorId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-acceptor-id
          required: true
          type: string
        - description: >-
            The Express accountId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-id
          required: true
          type: string
        - description: >-
            The Express accountToken. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-token
          required: true
          type: string
        - description: >-
            A unique ID for this request. This value should be a UUID or GUID.
            <a href='https://triposcert.vantiv.com/api/help/kb/requestid.html'>more&raquo;</a>
          in: header
          name: tp-request-id
          required: true
          type: string
        - description: Set to true to have logs populated in the response.
          in: header
          name: tp-return-logs
          required: false
          type: boolean
        - default: application/json
          description: Content type for request.
          in: header
          name: Content-Type
          required: true
          type: string
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/CardResponse'
      tags:
        - Pinpad
      operationId: getv1pinpadcard
      summary: '[Deprecated] Use /v1/card instead'
  /api/v1/pinpad/card/financial:
    get:
      parameters:
        - description: The ID of the business application.
          in: header
          name: tp-application-id
          required: true
          type: string
        - description: The name of the business application.
          in: header
          name: tp-application-name
          required: true
          type: string
        - description: The version of the business application.
          in: header
          name: tp-application-version
          required: true
          type: string
        - description: The authorization header.
          in: header
          name: tp-authorization
          required: true
          type: string
        - description: >-
            The Express acceptorId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-acceptor-id
          required: true
          type: string
        - description: >-
            The Express accountId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-id
          required: true
          type: string
        - description: >-
            The Express accountToken. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-token
          required: true
          type: string
        - description: >-
            A unique ID for this request. This value should be a UUID or GUID.
            <a href='https://triposcert.vantiv.com/api/help/kb/requestid.html'>more&raquo;</a>
          in: header
          name: tp-request-id
          required: true
          type: string
        - description: Set to true to have logs populated in the response.
          in: header
          name: tp-return-logs
          required: false
          type: boolean
        - default: application/json
          description: Content type for request.
          in: header
          name: Content-Type
          required: true
          type: string
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/FinancialCardResponse'
      tags:
        - Pinpad
      operationId: getv1pinpadcardfinancial
      summary: '[Deprecated] Use /v1/card/financial instead'
  '/api/v1/pinpad/card/financial/{laneId}':
    get:
      parameters:
        - description: The lane ID.
          format: int32
          in: path
          name: laneId
          required: true
          type: integer
        - description: The flag that indicates if encrypted card data needs to be obtained.
          in: query
          name: isEncryptedDataNeeded
          required: false
          type: boolean
        - description: The flag that invokes manual entry directly.
          in: query
          name: invokeManualEntry
          required: false
          type: boolean
        - description: >-
            Invokes prompt for cardholder to enter card security code for manual
            keyed card entry.
          in: query
          name: isCscSupported
          required: false
          type: string
        - description: The ID of the business application.
          in: header
          name: tp-application-id
          required: true
          type: string
        - description: The name of the business application.
          in: header
          name: tp-application-name
          required: true
          type: string
        - description: The version of the business application.
          in: header
          name: tp-application-version
          required: true
          type: string
        - description: The authorization header.
          in: header
          name: tp-authorization
          required: true
          type: string
        - description: >-
            The Express acceptorId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-acceptor-id
          required: true
          type: string
        - description: >-
            The Express accountId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-id
          required: true
          type: string
        - description: >-
            The Express accountToken. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-token
          required: true
          type: string
        - description: >-
            A unique ID for this request. This value should be a UUID or GUID.
            <a href='https://triposcert.vantiv.com/api/help/kb/requestid.html'>more&raquo;</a>
          in: header
          name: tp-request-id
          required: true
          type: string
        - description: Set to true to have logs populated in the response.
          in: header
          name: tp-return-logs
          required: false
          type: boolean
        - default: application/json
          description: Content type for request.
          in: header
          name: Content-Type
          required: true
          type: string
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/FinancialCardResponse'
        '404':
          description: Returned if no financial data can be found when the card is swiped.
      tags:
        - Pinpad
      operationId: getv1pinpadcardfinanciallaneId
      summary: '[Deprecated] Use /v1/card/financial/{laneId} instead'
  /api/v1/pinpad/card/nonfinancial:
    get:
      parameters:
        - description: The ID of the business application.
          in: header
          name: tp-application-id
          required: true
          type: string
        - description: The name of the business application.
          in: header
          name: tp-application-name
          required: true
          type: string
        - description: The version of the business application.
          in: header
          name: tp-application-version
          required: true
          type: string
        - description: The authorization header.
          in: header
          name: tp-authorization
          required: true
          type: string
        - description: >-
            The Express acceptorId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-acceptor-id
          required: true
          type: string
        - description: >-
            The Express accountId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-id
          required: true
          type: string
        - description: >-
            The Express accountToken. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-token
          required: true
          type: string
        - description: >-
            A unique ID for this request. This value should be a UUID or GUID.
            <a href='https://triposcert.vantiv.com/api/help/kb/requestid.html'>more&raquo;</a>
          in: header
          name: tp-request-id
          required: true
          type: string
        - description: Set to true to have logs populated in the response.
          in: header
          name: tp-return-logs
          required: false
          type: boolean
        - default: application/json
          description: Content type for request.
          in: header
          name: Content-Type
          required: true
          type: string
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/NonFinancialCardResponse'
      tags:
        - Pinpad
      operationId: getv1pinpadcardnonfinancial
      summary: '[Deprecated] Use /v1/card/nonfinancial instead'
  '/api/v1/pinpad/card/nonfinancial/{laneId}':
    get:
      parameters:
        - description: The lane ID.
          format: int32
          in: path
          name: laneId
          required: true
          type: integer
        - description: The flag that invokes manual entry directly.
          in: query
          name: invokeManualEntry
          required: false
          type: boolean
        - description: >-
            Invokes prompt for cardholder to enter card security code for manual
            keyed card entry.
          in: query
          name: isCscSupported
          required: false
          type: string
        - description: The ID of the business application.
          in: header
          name: tp-application-id
          required: true
          type: string
        - description: The name of the business application.
          in: header
          name: tp-application-name
          required: true
          type: string
        - description: The version of the business application.
          in: header
          name: tp-application-version
          required: true
          type: string
        - description: The authorization header.
          in: header
          name: tp-authorization
          required: true
          type: string
        - description: >-
            The Express acceptorId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-acceptor-id
          required: true
          type: string
        - description: >-
            The Express accountId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-id
          required: true
          type: string
        - description: >-
            The Express accountToken. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-token
          required: true
          type: string
        - description: >-
            A unique ID for this request. This value should be a UUID or GUID.
            <a href='https://triposcert.vantiv.com/api/help/kb/requestid.html'>more&raquo;</a>
          in: header
          name: tp-request-id
          required: true
          type: string
        - description: Set to true to have logs populated in the response.
          in: header
          name: tp-return-logs
          required: false
          type: boolean
        - default: application/json
          description: Content type for request.
          in: header
          name: Content-Type
          required: true
          type: string
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/NonFinancialCardResponse'
        '404':
          description: >-
            If no 'non-financial' data can be found when the card is swiped,
            tripos returns an HTTP status code of 404.
      tags:
        - Pinpad
      operationId: getv1pinpadcardnonfinanciallaneId
      summary: '[Deprecated] Use /v1/card/nonfinancial/{laneId} instead'
  '/api/v1/pinpad/card/{laneId}':
    get:
      parameters:
        - description: The lane ID.
          format: int32
          in: path
          name: laneId
          required: true
          type: integer
        - description: The flag that indicates if encrypted card data needs to be obtained.
          in: query
          name: isEncryptedDataNeeded
          required: false
          type: boolean
        - description: The flag that invokes manual entry directly.
          in: query
          name: invokeManualEntry
          required: false
          type: boolean
        - description: >-
            Invokes prompt for cardholder to enter card security code for manual
            keyed card entry.
          in: query
          name: isCscSupported
          required: false
          type: string
        - description: The ID of the business application.
          in: header
          name: tp-application-id
          required: true
          type: string
        - description: The name of the business application.
          in: header
          name: tp-application-name
          required: true
          type: string
        - description: The version of the business application.
          in: header
          name: tp-application-version
          required: true
          type: string
        - description: The authorization header.
          in: header
          name: tp-authorization
          required: true
          type: string
        - description: >-
            The Express acceptorId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-acceptor-id
          required: true
          type: string
        - description: >-
            The Express accountId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-id
          required: true
          type: string
        - description: >-
            The Express accountToken. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-token
          required: true
          type: string
        - description: >-
            A unique ID for this request. This value should be a UUID or GUID.
            <a href='https://triposcert.vantiv.com/api/help/kb/requestid.html'>more&raquo;</a>
          in: header
          name: tp-request-id
          required: true
          type: string
        - description: Set to true to have logs populated in the response.
          in: header
          name: tp-return-logs
          required: false
          type: boolean
        - default: application/json
          description: Content type for request.
          in: header
          name: Content-Type
          required: true
          type: string
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/CardResponse'
        '404':
          description: >-
            If no data can be found when the card is swiped, tripos returns an
            HTTP status code of 404.
      tags:
        - Pinpad
      operationId: getv1pinpadcardlaneId
      summary: '[Deprecated] Use /v1/card/{laneId} instead'
  /api/v1/reboot:
    post:
      parameters:
        - description: The ID of the business application.
          in: header
          name: tp-application-id
          required: true
          type: string
        - description: The name of the business application.
          in: header
          name: tp-application-name
          required: true
          type: string
        - description: The version of the business application.
          in: header
          name: tp-application-version
          required: true
          type: string
        - description: The authorization header.
          in: header
          name: tp-authorization
          required: true
          type: string
        - description: >-
            The Express acceptorId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-acceptor-id
          required: true
          type: string
        - description: >-
            The Express accountId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-id
          required: true
          type: string
        - description: >-
            The Express accountToken. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-token
          required: true
          type: string
        - description: >-
            A unique ID for this request. This value should be a UUID or GUID.
            <a href='https://triposcert.vantiv.com/api/help/kb/requestid.html'>more&raquo;</a>
          in: header
          name: tp-request-id
          required: true
          type: string
        - description: Set to true to have logs populated in the response.
          in: header
          name: tp-return-logs
          required: false
          type: boolean
        - default: application/json
          description: Content type for request.
          in: header
          name: Content-Type
          required: true
          type: string
        - in: body
          name: RebootLaneRequest
          required: false
          schema:
            $ref: '#/definitions/POST_RebootLaneRequest_v1_reboot'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/RebootLaneResponse'
        '400':
          description: Returned if the laneId is null or 0
        '404':
          description: Returned if the laneId is not valid
        '500':
          description: Returned if the PIN pad is disconnected or lane is already in use
      tags:
        - Reboot
      description: >-
        Use the reboot endpoint to reboot a specified PIN pad. See <a
        href='https://triposcert.vantiv.com/api/help/kb/reboot.html'>reboot documentation</a> for more
        information.
      operationId: postv1reboot
      summary: Reboots a specified lane
  /api/v1/receipt:
    post:
      parameters:
        - description: The ID of the business application.
          in: header
          name: tp-application-id
          required: true
          type: string
        - description: The name of the business application.
          in: header
          name: tp-application-name
          required: true
          type: string
        - description: The version of the business application.
          in: header
          name: tp-application-version
          required: true
          type: string
        - description: The authorization header.
          in: header
          name: tp-authorization
          required: true
          type: string
        - description: >-
            The Express acceptorId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-acceptor-id
          required: true
          type: string
        - description: >-
            The Express accountId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-id
          required: true
          type: string
        - description: >-
            The Express accountToken. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-token
          required: true
          type: string
        - description: >-
            A unique ID for this request. This value should be a UUID or GUID.
            <a href='https://triposcert.vantiv.com/api/help/kb/requestid.html'>more&raquo;</a>
          in: header
          name: tp-request-id
          required: true
          type: string
        - description: Set to true to have logs populated in the response.
          in: header
          name: tp-return-logs
          required: false
          type: boolean
        - default: application/json
          description: Content type for request.
          in: header
          name: Content-Type
          required: true
          type: string
        - in: body
          name: ReceiptRequest
          required: false
          schema:
            $ref: '#/definitions/POST_ReceiptRequest_v1_receipt'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/ReceiptResponse'
      tags:
        - Receipt
      description: >-
        This endpoint supports printing functionality. See <a
        href='https://triposcert.vantiv.com/api/help/kb/Receipt.html'> Receipt documentation</a> for more
        information.
      operationId: postv1receipt
      summary: Prints a receipt on a PIN pad using the posted data.
  /api/v1/refund:
    post:
      parameters:
        - description: >-
            The action to perform with the refund. This can either be 'store' or
            'forward'. More information on <a
            href='https://triposcert.vantiv.com/api/help/kb/storeForward.html'>Store and Forward</a> here.
          in: query
          name: action
          required: false
          type: string
        - description: The request ID of the stored transaction to forward.
          in: query
          name: requestIdToForward
          required: false
          type: string
        - description: The ID of the business application.
          in: header
          name: tp-application-id
          required: true
          type: string
        - description: The name of the business application.
          in: header
          name: tp-application-name
          required: true
          type: string
        - description: The version of the business application.
          in: header
          name: tp-application-version
          required: true
          type: string
        - description: The authorization header.
          in: header
          name: tp-authorization
          required: true
          type: string
        - description: >-
            The Express acceptorId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-acceptor-id
          required: true
          type: string
        - description: >-
            The Express accountId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-id
          required: true
          type: string
        - description: >-
            The Express accountToken. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-token
          required: true
          type: string
        - description: >-
            A unique ID for this request. This value should be a UUID or GUID.
            <a href='https://triposcert.vantiv.com/api/help/kb/requestid.html'>more&raquo;</a>
          in: header
          name: tp-request-id
          required: true
          type: string
        - description: Set to true to have logs populated in the response.
          in: header
          name: tp-return-logs
          required: false
          type: boolean
        - default: application/json
          description: Content type for request.
          in: header
          name: Content-Type
          required: true
          type: string
        - in: body
          name: RefundRequest
          required: false
          schema:
            $ref: '#/definitions/POST_RefundRequest_v1_refund'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/RefundResponse'
        '401':
          description: >-
            Returned if the AcceptorId, AccountId, AccountToken and TerminalId
            (config file only) are not provided in the HTTP request header or in
            the config file.
      tags:
        - Refund
      description: >-
        Creates a new card refund based on the passed in parameters. <a
        href='https://triposcert.vantiv.com/api/help/kb/refund.html'>More&raquo;</a>  Additionally, this
        endpoint supports QuickChip/PreRead functionality. See <a
        href='https://triposcert.vantiv.com/api/help/kb/cloud/QuickChipConfiguration.html'> QuickChip/PreRead
        documentation</a> for more information.
      operationId: postv1refund
      summary: Creates a new card refund based on the passed in parameters
  /api/v1/refund/token:
    post:
      parameters:
        - description: The ID of the business application.
          in: header
          name: tp-application-id
          required: true
          type: string
        - description: The name of the business application.
          in: header
          name: tp-application-name
          required: true
          type: string
        - description: The version of the business application.
          in: header
          name: tp-application-version
          required: true
          type: string
        - description: The authorization header.
          in: header
          name: tp-authorization
          required: true
          type: string
        - description: >-
            The Express acceptorId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-acceptor-id
          required: true
          type: string
        - description: >-
            The Express accountId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-id
          required: true
          type: string
        - description: >-
            The Express accountToken. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-token
          required: true
          type: string
        - description: >-
            A unique ID for this request. This value should be a UUID or GUID.
            <a href='https://triposcert.vantiv.com/api/help/kb/requestid.html'>more&raquo;</a>
          in: header
          name: tp-request-id
          required: true
          type: string
        - description: Set to true to have logs populated in the response.
          in: header
          name: tp-return-logs
          required: false
          type: boolean
        - default: application/json
          description: Content type for request.
          in: header
          name: Content-Type
          required: true
          type: string
        - in: body
          name: TokenRefundRequest
          required: false
          schema:
            $ref: '#/definitions/POST_TokenRefundRequest_v1_refund_token'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/TokenRefundResponse'
        '401':
          description: >-
            Returned if the AcceptorId, AccountId, AccountToken and TerminalId
            (config file only) are not provided in the HTTP request header or in
            the config file.
      tags:
        - Refund
      description: >-
        See <a href='https://triposcert.vantiv.com/api/help/kb/omniToken.html'>OmniToken documentation</a> for
        more information.
      operationId: postv1refundtoken
      summary: Creates a new card refund using a token based on the passed in amounts
  '/api/v1/refund/{paymentAccountId}':
    post:
      parameters:
        - description: The payment account ID.
          in: path
          name: paymentAccountId
          required: true
          type: string
        - description: The ID of the business application.
          in: header
          name: tp-application-id
          required: true
          type: string
        - description: The name of the business application.
          in: header
          name: tp-application-name
          required: true
          type: string
        - description: The version of the business application.
          in: header
          name: tp-application-version
          required: true
          type: string
        - description: The authorization header.
          in: header
          name: tp-authorization
          required: true
          type: string
        - description: >-
            The Express acceptorId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-acceptor-id
          required: true
          type: string
        - description: >-
            The Express accountId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-id
          required: true
          type: string
        - description: >-
            The Express accountToken. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-token
          required: true
          type: string
        - description: >-
            A unique ID for this request. This value should be a UUID or GUID.
            <a href='https://triposcert.vantiv.com/api/help/kb/requestid.html'>more&raquo;</a>
          in: header
          name: tp-request-id
          required: true
          type: string
        - description: Set to true to have logs populated in the response.
          in: header
          name: tp-return-logs
          required: false
          type: boolean
        - default: application/json
          description: Content type for request.
          in: header
          name: Content-Type
          required: true
          type: string
        - in: body
          name: PaymentAccountRefundRequest
          required: false
          schema:
            $ref: >-
              #/definitions/POST_PaymentAccountRefundRequest_v1_refund_paymentAccountId
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/PaymentAccountRefundResponse'
        '401':
          description: >-
            Returned if the AcceptorId, AccountId, AccountToken and TerminalId
            (config file only) are not provided in the HTTP request header or in
            the config file.
      tags:
        - Refund
      operationId: postv1refundpaymentAccountId
      summary: Creates a new payment account refund based on the passed in parameters
  '/api/v1/return/{transactionId}/{paymentType}':
    post:
      parameters:
        - description: The original payment type.
          in: path
          name: paymentType
          required: true
          type: string
        - description: The ID of a previous transaction.
          in: path
          name: transactionId
          required: true
          type: string
        - description: The ID of the business application.
          in: header
          name: tp-application-id
          required: true
          type: string
        - description: The name of the business application.
          in: header
          name: tp-application-name
          required: true
          type: string
        - description: The version of the business application.
          in: header
          name: tp-application-version
          required: true
          type: string
        - description: The authorization header.
          in: header
          name: tp-authorization
          required: true
          type: string
        - description: >-
            The Express acceptorId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-acceptor-id
          required: true
          type: string
        - description: >-
            The Express accountId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-id
          required: true
          type: string
        - description: >-
            The Express accountToken. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-token
          required: true
          type: string
        - description: >-
            A unique ID for this request. This value should be a UUID or GUID.
            <a href='https://triposcert.vantiv.com/api/help/kb/requestid.html'>more&raquo;</a>
          in: header
          name: tp-request-id
          required: true
          type: string
        - description: Set to true to have logs populated in the response.
          in: header
          name: tp-return-logs
          required: false
          type: boolean
        - default: application/json
          description: Content type for request.
          in: header
          name: Content-Type
          required: true
          type: string
        - in: body
          name: ReturnRequest
          required: false
          schema:
            $ref: >-
              #/definitions/POST_ReturnRequest_v1_return_transactionId_paymentType
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/ReturnResponse'
        '401':
          description: >-
            Returned if the AcceptorId, AccountId, AccountToken and TerminalId
            (config file only) are not provided in the HTTP request header or in
            the config file.
      tags:
        - Return
      description: >-
        Creates a new card return based on the passed in parameters. <a
        href='https://triposcert.vantiv.com/api/help/kb/return.html'>More&raquo;</a>
      operationId: postv1returntransactionIdpaymentType
      summary: Creates a new card return based on the passed in parameters
  '/api/v1/reversal/{transactionId}/{paymentType}':
    post:
      parameters:
        - description: The original payment type.
          in: path
          name: paymentType
          required: true
          type: string
        - description: The ID of a previous transaction.
          in: path
          name: transactionId
          required: true
          type: string
        - description: The type of reversal.
          in: query
          name: type
          required: false
          type: string
        - description: The ID of the business application.
          in: header
          name: tp-application-id
          required: true
          type: string
        - description: The name of the business application.
          in: header
          name: tp-application-name
          required: true
          type: string
        - description: The version of the business application.
          in: header
          name: tp-application-version
          required: true
          type: string
        - description: The authorization header.
          in: header
          name: tp-authorization
          required: true
          type: string
        - description: >-
            The Express acceptorId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-acceptor-id
          required: true
          type: string
        - description: >-
            The Express accountId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-id
          required: true
          type: string
        - description: >-
            The Express accountToken. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-token
          required: true
          type: string
        - description: >-
            A unique ID for this request. This value should be a UUID or GUID.
            <a href='https://triposcert.vantiv.com/api/help/kb/requestid.html'>more&raquo;</a>
          in: header
          name: tp-request-id
          required: true
          type: string
        - description: Set to true to have logs populated in the response.
          in: header
          name: tp-return-logs
          required: false
          type: boolean
        - default: application/json
          description: Content type for request.
          in: header
          name: Content-Type
          required: true
          type: string
        - in: body
          name: ReversalRequest
          required: false
          schema:
            $ref: >-
              #/definitions/POST_ReversalRequest_v1_reversal_transactionId_paymentType
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/ReversalResponse'
        '401':
          description: >-
            Returned if the AcceptorId, AccountId, AccountToken and TerminalId
            (config file only) are not provided in the HTTP request header or in
            the config file.
      tags:
        - Reversal
      operationId: postv1reversaltransactionIdpaymentType
      summary: >-
        Creates a new full reversal based on given transaction ID, payment type,
        and the passed in amounts
  /api/v1/sale:
    post:
      parameters:
        - description: >-
            The action to perform with the sale. This can either be 'store' or
            'forward'. More information on <a
            href='https://triposcert.vantiv.com/api/help/kb/storeForward.html'>Store and Forward</a> here.
          in: query
          name: action
          required: false
          type: string
        - description: The request ID of the stored transaction to forward.
          in: query
          name: requestIdToForward
          required: false
          type: string
        - description: The ID of the business application.
          in: header
          name: tp-application-id
          required: true
          type: string
        - description: The name of the business application.
          in: header
          name: tp-application-name
          required: true
          type: string
        - description: The version of the business application.
          in: header
          name: tp-application-version
          required: true
          type: string
        - description: The authorization header.
          in: header
          name: tp-authorization
          required: true
          type: string
        - description: >-
            The Express acceptorId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-acceptor-id
          required: true
          type: string
        - description: >-
            The Express accountId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-id
          required: true
          type: string
        - description: >-
            The Express accountToken. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-token
          required: true
          type: string
        - description: >-
            A unique ID for this request. This value should be a UUID or GUID.
            <a href='https://triposcert.vantiv.com/api/help/kb/requestid.html'>more&raquo;</a>
          in: header
          name: tp-request-id
          required: true
          type: string
        - description: Set to true to have logs populated in the response.
          in: header
          name: tp-return-logs
          required: false
          type: boolean
        - default: application/json
          description: Content type for request.
          in: header
          name: Content-Type
          required: true
          type: string
        - in: body
          name: SaleRequest
          required: false
          schema:
            $ref: '#/definitions/POST_SaleRequest_v1_sale'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/SaleResponse'
        '400':
          description: >-
            1) Returned if action is forward and if the requestIdToForward is
            missing or is not a valid GUID. 2) Returned if client sends in all 5
            of the healthcare values as positive values. 3) Returned if any
            healthcare field has a negative value. 4) Returned if healthcare
            Total field is less than sum of the other healthcare fields. 5)
            Returned if action is store and the customer swipes a healthcare
            card. 6) Returned if MarketCode is not HotelLodging but the request
            includes lodging parameters on a valid lodging request. 7) Returned
            if the lodging checkInDate or checkOutDate is not in the ISO 8601
            format of YYYY-MM-DD on a valid lodging request. 8) Returned if the
            lodging roomAmount is less than 0.00 on a valid lodging request. 9)
            Returned if the lodging duration is less than 0 on a valid lodging
            request. 10) Returned if the cashbackOptions maximumAmount is either
            not provided, or is not an integer greater than zero. 11) Returned
            if the cashbackOptions amountIncrement is not an integer greater
            than zero. If it is not provided, it will default to 1.
        '401':
          description: >-
            Returned if the AcceptorId, AccountId, AccountToken and TerminalId
            (config file only) are not provided in the HTTP request header or in
            the config file.
        '404':
          description: >-
            Returned if action is store or forward and if the given
            requestIdToForward cannot be found in the database.
        '500':
          description: >-
            1) Returned if action is store or forward and if an error occurs
            while saving the sale to the database. 2) Returned if action is
            store or forward and if the stored message cannot be deserialized
            into the original stored object. 3) Returned if action is store or
            forward and if the stored message content is blank. 4) Returned if
            action is store or forward and if triPOS is unable to pull the
            stored record from the database.
      tags:
        - Sale
      description: "Review this document for information on requiring the PIN pad to prompt for the cardholder to accept the <a href='https://triposcert.vantiv.com/api/help/kb/convenienceFeeAmount.html'>convenienceFeeAmount.</a> Additionally, this endpoint supports QuickChip/PreRead functionality. See <a href='https://triposcert.vantiv.com/api/help/kb/cloud/QuickChipConfiguration.html'> QuickChip/PreRead documentation</a> for more information.<br><b>DO NOT</b> use as a regular-interval\_health status check."
      operationId: postv1sale
      summary: Creates a new card sale based on the passed in amounts.
  /api/v1/sale/token:
    post:
      parameters:
        - description: The ID of the business application.
          in: header
          name: tp-application-id
          required: true
          type: string
        - description: The name of the business application.
          in: header
          name: tp-application-name
          required: true
          type: string
        - description: The version of the business application.
          in: header
          name: tp-application-version
          required: true
          type: string
        - description: The authorization header.
          in: header
          name: tp-authorization
          required: true
          type: string
        - description: >-
            The Express acceptorId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-acceptor-id
          required: true
          type: string
        - description: >-
            The Express accountId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-id
          required: true
          type: string
        - description: >-
            The Express accountToken. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-token
          required: true
          type: string
        - description: >-
            A unique ID for this request. This value should be a UUID or GUID.
            <a href='https://triposcert.vantiv.com/api/help/kb/requestid.html'>more&raquo;</a>
          in: header
          name: tp-request-id
          required: true
          type: string
        - description: Set to true to have logs populated in the response.
          in: header
          name: tp-return-logs
          required: false
          type: boolean
        - default: application/json
          description: Content type for request.
          in: header
          name: Content-Type
          required: true
          type: string
        - in: body
          name: TokenSaleRequest
          required: false
          schema:
            $ref: '#/definitions/POST_TokenSaleRequest_v1_sale_token'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/TokenSaleResponse'
        '401':
          description: >-
            Returned if the AcceptorId, AccountId, AccountToken and TerminalId
            (config file only) are not provided in the HTTP request header or in
            the config file.
      tags:
        - Sale
      description: >-
        See <a href='https://triposcert.vantiv.com/api/help/kb/omniToken.html'>OmniToken documentation</a> for
        more information.
      operationId: postv1saletoken
      summary: Creates a new card sale using a token based on the passed in amounts
  '/api/v1/sale/{paymentAccountId}':
    post:
      parameters:
        - description: The payment account ID.
          in: path
          name: paymentAccountId
          required: true
          type: string
        - description: The ID of the business application.
          in: header
          name: tp-application-id
          required: true
          type: string
        - description: The name of the business application.
          in: header
          name: tp-application-name
          required: true
          type: string
        - description: The version of the business application.
          in: header
          name: tp-application-version
          required: true
          type: string
        - description: The authorization header.
          in: header
          name: tp-authorization
          required: true
          type: string
        - description: >-
            The Express acceptorId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-acceptor-id
          required: true
          type: string
        - description: >-
            The Express accountId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-id
          required: true
          type: string
        - description: >-
            The Express accountToken. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-token
          required: true
          type: string
        - description: >-
            A unique ID for this request. This value should be a UUID or GUID.
            <a href='https://triposcert.vantiv.com/api/help/kb/requestid.html'>more&raquo;</a>
          in: header
          name: tp-request-id
          required: true
          type: string
        - description: Set to true to have logs populated in the response.
          in: header
          name: tp-return-logs
          required: false
          type: boolean
        - default: application/json
          description: Content type for request.
          in: header
          name: Content-Type
          required: true
          type: string
        - in: body
          name: PaymentAccountSaleRequest
          required: false
          schema:
            $ref: >-
              #/definitions/POST_PaymentAccountSaleRequest_v1_sale_paymentAccountId
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/PaymentAccountSaleResponse'
        '401':
          description: >-
            Returned if the AcceptorId, AccountId, AccountToken and TerminalId
            (config file only) are not provided in the HTTP request header or in
            the config file.
      tags:
        - Sale
      operationId: postv1salepaymentAccountId
      summary: Creates a new payment account sale based on the passed in amounts
  '/api/v1/sale/{transactionId}/return/{paymentType}':
    post:
      parameters:
        - description: The original payment type.
          in: path
          name: paymentType
          required: true
          type: string
        - description: The ID of a previous transaction.
          in: path
          name: transactionId
          required: true
          type: string
        - description: The ID of the business application.
          in: header
          name: tp-application-id
          required: true
          type: string
        - description: The name of the business application.
          in: header
          name: tp-application-name
          required: true
          type: string
        - description: The version of the business application.
          in: header
          name: tp-application-version
          required: true
          type: string
        - description: The authorization header.
          in: header
          name: tp-authorization
          required: true
          type: string
        - description: >-
            The Express acceptorId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-acceptor-id
          required: true
          type: string
        - description: >-
            The Express accountId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-id
          required: true
          type: string
        - description: >-
            The Express accountToken. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-token
          required: true
          type: string
        - description: >-
            A unique ID for this request. This value should be a UUID or GUID.
            <a href='https://triposcert.vantiv.com/api/help/kb/requestid.html'>more&raquo;</a>
          in: header
          name: tp-request-id
          required: true
          type: string
        - description: Set to true to have logs populated in the response.
          in: header
          name: tp-return-logs
          required: false
          type: boolean
        - default: application/json
          description: Content type for request.
          in: header
          name: Content-Type
          required: true
          type: string
        - in: body
          name: ReturnRequest
          required: false
          schema:
            $ref: >-
              #/definitions/POST_ReturnRequest_v1_sale_transactionId_return_paymentType
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/ReturnResponse'
        '401':
          description: >-
            Returned if the AcceptorId, AccountId, AccountToken and TerminalId
            (config file only) are not provided in the HTTP request header or in
            the config file.
      tags:
        - Sale
      operationId: postv1saletransactionIdreturnpaymentType
      summary: '[Deprecated] Use /v1/return/{transactionId}/{paymentType} instead'
  /api/v1/scrollingDisplay:
    post:
      parameters:
        - description: The ID of the business application.
          in: header
          name: tp-application-id
          required: true
          type: string
        - description: The name of the business application.
          in: header
          name: tp-application-name
          required: true
          type: string
        - description: The version of the business application.
          in: header
          name: tp-application-version
          required: true
          type: string
        - description: The authorization header.
          in: header
          name: tp-authorization
          required: true
          type: string
        - description: >-
            The Express acceptorId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-acceptor-id
          required: true
          type: string
        - description: >-
            The Express accountId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-id
          required: true
          type: string
        - description: >-
            The Express accountToken. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-token
          required: true
          type: string
        - description: >-
            A unique ID for this request. This value should be a UUID or GUID.
            <a href='https://triposcert.vantiv.com/api/help/kb/requestid.html'>more&raquo;</a>
          in: header
          name: tp-request-id
          required: true
          type: string
        - description: Set to true to have logs populated in the response.
          in: header
          name: tp-return-logs
          required: false
          type: boolean
        - default: application/json
          description: Content type for request.
          in: header
          name: Content-Type
          required: true
          type: string
        - in: body
          name: ScrollingDisplayRequest
          required: false
          schema:
            $ref: '#/definitions/POST_ScrollingDisplayRequest_v1_scrollingDisplay'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/DisplayResponse'
        '400':
          description: Returned if parameter values are missing or invalid.
      tags:
        - ScrollingDisplay
      description: >-
        Use the scrolling display endpoint to repeatedly add items to a scroll
        area of the PIN pad screen while displaying the subtotal, tax, and total
        of the transaction. This endpoint returns an HTTP status code of 200 if
        the text was successfully displayed on the PIN pad. See <a
        href='https://triposcert.vantiv.com/api/help/kb/scrollingDisplay.html'>scrolling display
        documentation</a> fore more information.
      operationId: postv1scrollingDisplay
      summary: >-
        Displays an item on an area of the PIN pad screen that scrolls as items
        are added.
  /api/v1/selection:
    get:
      parameters:
        - description: The ID of the business application.
          in: header
          name: tp-application-id
          required: true
          type: string
        - description: The name of the business application.
          in: header
          name: tp-application-name
          required: true
          type: string
        - description: The version of the business application.
          in: header
          name: tp-application-version
          required: true
          type: string
        - description: The authorization header.
          in: header
          name: tp-authorization
          required: true
          type: string
        - description: >-
            The Express acceptorId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-acceptor-id
          required: true
          type: string
        - description: >-
            The Express accountId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-id
          required: true
          type: string
        - description: >-
            The Express accountToken. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-token
          required: true
          type: string
        - description: >-
            A unique ID for this request. This value should be a UUID or GUID.
            <a href='https://triposcert.vantiv.com/api/help/kb/requestid.html'>more&raquo;</a>
          in: header
          name: tp-request-id
          required: true
          type: string
        - description: Set to true to have logs populated in the response.
          in: header
          name: tp-return-logs
          required: false
          type: boolean
        - default: application/json
          description: Content type for request.
          in: header
          name: Content-Type
          required: true
          type: string
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/SelectionDiscoveryResponse'
      tags:
        - Selection
      operationId: getv1selection
      summary: >-
        The list of links for the selection endpoints including only lanes with
        a pinpad capable of selection entry
  '/api/v1/selection/{laneId}':
    get:
      parameters:
        - description: The lane ID.
          in: path
          name: laneId
          required: true
          type: string
        - description: >-
            The selection form to display. <a
            href='https://triposcert.vantiv.com/api/help/kb/selection.html'>more&raquo;</a>
          in: query
          name: form
          required: true
          type: string
        - description: >-
            The header text to display to the cardholder. This is only used for
            the YesNoTextArea or MultiOptionTextArea form.
          in: query
          name: header
          required: false
          type: string
        - description: >-
            The subheader text to display to the cardholder. This is only used
            for the YesNoTextArea or MultiOptionTextArea form.
          in: query
          name: subHeader
          required: false
          type: string
        - description: >-
            The text to display to the cardholder. For the MultiOption form,
            this is the prompt text. For the YesNoTextArea form, this is the
            text for the text area. Use | (pipe) for newline.
          in: query
          name: text
          required: false
          type: string
        - description: >-
            The list of individual lines of text to be displayed on the PIN pad.
            Separate each text with a pipe '|' (e.g.
            multiLineText=promptLine1|promptLine2). For the MultiOption form,
            this is the prompt text.
          in: query
          name: multiLineText
          required: false
          type: string
        - description: >-
            The selection options to provide to the cardholder. Separate each
            option with a pipe '|' (e.g. options=one|two|three). This is only
            used with the MultiOption and MultiOptionTextArea forms.
          in: query
          name: options
          required: false
          type: string
        - description: The ID of the business application.
          in: header
          name: tp-application-id
          required: true
          type: string
        - description: The name of the business application.
          in: header
          name: tp-application-name
          required: true
          type: string
        - description: The version of the business application.
          in: header
          name: tp-application-version
          required: true
          type: string
        - description: The authorization header.
          in: header
          name: tp-authorization
          required: true
          type: string
        - description: >-
            The Express acceptorId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-acceptor-id
          required: true
          type: string
        - description: >-
            The Express accountId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-id
          required: true
          type: string
        - description: >-
            The Express accountToken. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-token
          required: true
          type: string
        - description: >-
            A unique ID for this request. This value should be a UUID or GUID.
            <a href='https://triposcert.vantiv.com/api/help/kb/requestid.html'>more&raquo;</a>
          in: header
          name: tp-request-id
          required: true
          type: string
        - description: Set to true to have logs populated in the response.
          in: header
          name: tp-return-logs
          required: false
          type: boolean
        - default: application/json
          description: Content type for request.
          in: header
          name: Content-Type
          required: true
          type: string
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/SelectionResponse'
        '400':
          description: Returned if the 'form' parameter is empty or invalid.
        '500':
          description: >-
            Returned if the cardholder doesn't respond within the specified
            amount of time.
      tags:
        - Selection
      description: >-
        Use the selection endpoint to get cardholder selections via the pinpad.
        See <a href='https://triposcert.vantiv.com/api/help/kb/selection.html'>selection documentation</a> for
        more information.
      operationId: getv1selectionlaneId
      summary: Displays the specified selection form
  /api/v1/signature:
    get:
      parameters:
        - description: The ID of the business application.
          in: header
          name: tp-application-id
          required: true
          type: string
        - description: The name of the business application.
          in: header
          name: tp-application-name
          required: true
          type: string
        - description: The version of the business application.
          in: header
          name: tp-application-version
          required: true
          type: string
        - description: The authorization header.
          in: header
          name: tp-authorization
          required: true
          type: string
        - description: >-
            The Express acceptorId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-acceptor-id
          required: true
          type: string
        - description: >-
            The Express accountId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-id
          required: true
          type: string
        - description: >-
            The Express accountToken. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-token
          required: true
          type: string
        - description: >-
            A unique ID for this request. This value should be a UUID or GUID.
            <a href='https://triposcert.vantiv.com/api/help/kb/requestid.html'>more&raquo;</a>
          in: header
          name: tp-request-id
          required: true
          type: string
        - description: Set to true to have logs populated in the response.
          in: header
          name: tp-return-logs
          required: false
          type: boolean
        - default: application/json
          description: Content type for request.
          in: header
          name: Content-Type
          required: true
          type: string
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/SignatureResponse'
      tags:
        - Signature
      operationId: getv1signature
      summary: >-
        The list of links for the signature endpoints including only lanes with
        a pinpad capable of signature entry
  '/api/v1/signature/{laneId}':
    get:
      parameters:
        - description: The lane ID.
          format: int32
          in: path
          name: laneId
          required: true
          type: integer
        - description: The header text to display to the cardholder.
          in: query
          name: header
          required: false
          type: string
        - description: The subheader text to display to the cardholder.
          in: query
          name: subHeader
          required: false
          type: string
        - description: The text to display to the cardholder.
          in: query
          name: text
          required: false
          type: string
        - description: >-
            The signature form to display. Options are 'simple' and 'contract'.
            <a href='https://triposcert.vantiv.com/api/help/kb/signature.html'>more &raquo;</a>
          in: query
          name: form
          required: true
          type: string
        - description: The ID of the business application.
          in: header
          name: tp-application-id
          required: true
          type: string
        - description: The name of the business application.
          in: header
          name: tp-application-name
          required: true
          type: string
        - description: The version of the business application.
          in: header
          name: tp-application-version
          required: true
          type: string
        - description: The authorization header.
          in: header
          name: tp-authorization
          required: true
          type: string
        - description: >-
            The Express acceptorId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-acceptor-id
          required: true
          type: string
        - description: >-
            The Express accountId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-id
          required: true
          type: string
        - description: >-
            The Express accountToken. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-token
          required: true
          type: string
        - description: >-
            A unique ID for this request. This value should be a UUID or GUID.
            <a href='https://triposcert.vantiv.com/api/help/kb/requestid.html'>more&raquo;</a>
          in: header
          name: tp-request-id
          required: true
          type: string
        - description: Set to true to have logs populated in the response.
          in: header
          name: tp-return-logs
          required: false
          type: boolean
        - default: application/json
          description: Content type for request.
          in: header
          name: Content-Type
          required: true
          type: string
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/GetLaneSignatureResponse'
      tags:
        - Signature
      description: >-
        Use the signature endpoint to get a cardholder signature via the pinpad.
        See <a href='https://triposcert.vantiv.com/api/help/kb/signature.html'>signature documentation</a> for
        more information.
      operationId: getv1signaturelaneId
      summary: Displays the specified signature form
  /api/v1/status:
    get:
      parameters:
        - description: The ID of the business application.
          in: header
          name: tp-application-id
          required: true
          type: string
        - description: The name of the business application.
          in: header
          name: tp-application-name
          required: true
          type: string
        - description: The version of the business application.
          in: header
          name: tp-application-version
          required: true
          type: string
        - description: The authorization header.
          in: header
          name: tp-authorization
          required: true
          type: string
        - description: >-
            The Express acceptorId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-acceptor-id
          required: true
          type: string
        - description: >-
            The Express accountId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-id
          required: true
          type: string
        - description: >-
            The Express accountToken. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-token
          required: true
          type: string
        - description: >-
            A unique ID for this request. This value should be a UUID or GUID.
            <a href='https://triposcert.vantiv.com/api/help/kb/requestid.html'>more&raquo;</a>
          in: header
          name: tp-request-id
          required: true
          type: string
        - description: Set to true to have logs populated in the response.
          in: header
          name: tp-return-logs
          required: false
          type: boolean
        - default: application/json
          description: Content type for request.
          in: header
          name: Content-Type
          required: true
          type: string
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/StatusResponse'
        '401':
          description: >-
            Returned if the AcceptorId, AccountId, AccountToken are not provided
            in the HTTP request header or in the config file.
      tags:
        - Status
      description: "<b>DO NOT</b> use as a regular-interval\_health status check."
      operationId: getv1status
      summary: Return a list of the triPOS status endpoints
  /api/v1/status/host:
    get:
      parameters:
        - description: The ID of the business application.
          in: header
          name: tp-application-id
          required: true
          type: string
        - description: The name of the business application.
          in: header
          name: tp-application-name
          required: true
          type: string
        - description: The version of the business application.
          in: header
          name: tp-application-version
          required: true
          type: string
        - description: The authorization header.
          in: header
          name: tp-authorization
          required: true
          type: string
        - description: >-
            The Express acceptorId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-acceptor-id
          required: true
          type: string
        - description: >-
            The Express accountId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-id
          required: true
          type: string
        - description: >-
            The Express accountToken. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-token
          required: true
          type: string
        - description: >-
            A unique ID for this request. This value should be a UUID or GUID.
            <a href='https://triposcert.vantiv.com/api/help/kb/requestid.html'>more&raquo;</a>
          in: header
          name: tp-request-id
          required: true
          type: string
        - description: Set to true to have logs populated in the response.
          in: header
          name: tp-return-logs
          required: false
          type: boolean
        - default: application/json
          description: Content type for request.
          in: header
          name: Content-Type
          required: true
          type: string
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/HostStatusResponse'
      tags:
        - Status
      description: >-
        May be used as a regular-interval health status check. <b>Max
        Interval</b>: Every <b>2</b> minutes. If used with another API endpoint
        that is suitable for a regular-interval health check, max frequency
        should reflect all such calls as a group.
      operationId: getv1statushost
      summary: Get host status
  '/api/v1/status/triPOS/{echo}':
    get:
      parameters:
        - description: Text value that will be echoed back in the response.
          format: int32
          in: path
          name: echo
          required: true
          type: integer
        - description: The ID of the business application.
          in: header
          name: tp-application-id
          required: true
          type: string
        - description: The name of the business application.
          in: header
          name: tp-application-name
          required: true
          type: string
        - description: The version of the business application.
          in: header
          name: tp-application-version
          required: true
          type: string
        - description: The authorization header.
          in: header
          name: tp-authorization
          required: true
          type: string
        - description: >-
            The Express acceptorId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-acceptor-id
          required: true
          type: string
        - description: >-
            The Express accountId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-id
          required: true
          type: string
        - description: >-
            The Express accountToken. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-token
          required: true
          type: string
        - description: >-
            A unique ID for this request. This value should be a UUID or GUID.
            <a href='https://triposcert.vantiv.com/api/help/kb/requestid.html'>more&raquo;</a>
          in: header
          name: tp-request-id
          required: true
          type: string
        - description: Set to true to have logs populated in the response.
          in: header
          name: tp-return-logs
          required: false
          type: boolean
        - default: application/json
          description: Content type for request.
          in: header
          name: Content-Type
          required: true
          type: string
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/TriPosStatusResponse'
      tags:
        - Status
      description: >-
        May be used as a regular-interval health status check. <b>Max
        Interval</b>: Every <b>2</b> minutes. If used with another API endpoint
        that is suitable for a regular-interval health check, max frequency
        should reflect all such calls as a group.
      operationId: getv1statustriPOSecho
      summary: >-
        Echos the text passed to triPOS. A successful echo indicates that triPOS
        is running and responding to requests
  /api/v1/token/omni:
    post:
      parameters:
        - description: The ID of the business application.
          in: header
          name: tp-application-id
          required: true
          type: string
        - description: The name of the business application.
          in: header
          name: tp-application-name
          required: true
          type: string
        - description: The version of the business application.
          in: header
          name: tp-application-version
          required: true
          type: string
        - description: The authorization header.
          in: header
          name: tp-authorization
          required: true
          type: string
        - description: >-
            The Express acceptorId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-acceptor-id
          required: true
          type: string
        - description: >-
            The Express accountId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-id
          required: true
          type: string
        - description: >-
            The Express accountToken. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-token
          required: true
          type: string
        - description: >-
            A unique ID for this request. This value should be a UUID or GUID.
            <a href='https://triposcert.vantiv.com/api/help/kb/requestid.html'>more&raquo;</a>
          in: header
          name: tp-request-id
          required: true
          type: string
        - description: Set to true to have logs populated in the response.
          in: header
          name: tp-return-logs
          required: false
          type: boolean
        - default: application/json
          description: Content type for request.
          in: header
          name: Content-Type
          required: true
          type: string
        - in: body
          name: CreateOmniTokenRequest
          required: false
          schema:
            $ref: '#/definitions/POST_CreateOmniTokenRequest_v1_token_omni'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/CreateOmniTokenResponse'
        '401':
          description: >-
            Returned if the AcceptorId, AccountId, AccountToken and TerminalId
            (config file only) are not provided in the HTTP request header or in
            the config file.
        '500':
          description: The token could not be created with the card used.
      tags:
        - Token
      description: This endpoint is for swipe capable omni token creation.
      operationId: postv1tokenomni
      summary: Creates a Omni token based on a card swipe
  '/api/v1/token/omni/{transactionId}':
    post:
      parameters:
        - description: The ID of a previous transaction.
          in: path
          name: transactionId
          required: true
          type: string
        - description: The ID of the business application.
          in: header
          name: tp-application-id
          required: true
          type: string
        - description: The name of the business application.
          in: header
          name: tp-application-name
          required: true
          type: string
        - description: The version of the business application.
          in: header
          name: tp-application-version
          required: true
          type: string
        - description: The authorization header.
          in: header
          name: tp-authorization
          required: true
          type: string
        - description: >-
            The Express acceptorId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-acceptor-id
          required: true
          type: string
        - description: >-
            The Express accountId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-id
          required: true
          type: string
        - description: >-
            The Express accountToken. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-token
          required: true
          type: string
        - description: >-
            A unique ID for this request. This value should be a UUID or GUID.
            <a href='https://triposcert.vantiv.com/api/help/kb/requestid.html'>more&raquo;</a>
          in: header
          name: tp-request-id
          required: true
          type: string
        - description: Set to true to have logs populated in the response.
          in: header
          name: tp-return-logs
          required: false
          type: boolean
        - default: application/json
          description: Content type for request.
          in: header
          name: Content-Type
          required: true
          type: string
        - in: body
          name: CreateOmniTokenWithTransIdRequest
          required: false
          schema:
            $ref: >-
              #/definitions/POST_CreateOmniTokenWithTransIdRequest_v1_token_omni_transactionId
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/CreateOmniTokenResponse'
        '401':
          description: >-
            Returned if the AcceptorId, AccountId, AccountToken and TerminalId
            (config file only) are not provided in the HTTP request header or in
            the config file.
        '500':
          description: The token could not be created with the transaction ID given.
      tags:
        - Token
      operationId: postv1tokenomnitransactionId
      summary: Creates a Omni token based on a previous transaction ID
  /api/v1/token/paymetric:
    post:
      parameters:
        - description: The ID of the business application.
          in: header
          name: tp-application-id
          required: true
          type: string
        - description: The name of the business application.
          in: header
          name: tp-application-name
          required: true
          type: string
        - description: The version of the business application.
          in: header
          name: tp-application-version
          required: true
          type: string
        - description: The authorization header.
          in: header
          name: tp-authorization
          required: true
          type: string
        - description: >-
            The Express acceptorId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-acceptor-id
          required: true
          type: string
        - description: >-
            The Express accountId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-id
          required: true
          type: string
        - description: >-
            The Express accountToken. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-token
          required: true
          type: string
        - description: >-
            A unique ID for this request. This value should be a UUID or GUID.
            <a href='https://triposcert.vantiv.com/api/help/kb/requestid.html'>more&raquo;</a>
          in: header
          name: tp-request-id
          required: true
          type: string
        - description: Set to true to have logs populated in the response.
          in: header
          name: tp-return-logs
          required: false
          type: boolean
        - default: application/json
          description: Content type for request.
          in: header
          name: Content-Type
          required: true
          type: string
        - in: body
          name: CreatePaymetricTokenRequest
          required: false
          schema:
            $ref: '#/definitions/POST_CreatePaymetricTokenRequest_v1_token_paymetric'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/CreatePaymetricTokenResponse'
        '401':
          description: >-
            Returned if the AcceptorId, AccountId, AccountToken and TerminalId
            (config file only) are not provided in the HTTP request header or in
            the config file.
        '500':
          description: The token could not be created with the card used.
      tags:
        - Token
      description: This endpoint is for swipe capable paymetric token creation.
      operationId: postv1tokenpaymetric
      summary: Creates a Paymetric token based on a card swipe
  '/api/v1/token/paymetric/{transactionId}':
    post:
      parameters:
        - description: The ID of a previous transaction.
          in: path
          name: transactionId
          required: true
          type: string
        - description: The ID of the business application.
          in: header
          name: tp-application-id
          required: true
          type: string
        - description: The name of the business application.
          in: header
          name: tp-application-name
          required: true
          type: string
        - description: The version of the business application.
          in: header
          name: tp-application-version
          required: true
          type: string
        - description: The authorization header.
          in: header
          name: tp-authorization
          required: true
          type: string
        - description: >-
            The Express acceptorId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-acceptor-id
          required: true
          type: string
        - description: >-
            The Express accountId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-id
          required: true
          type: string
        - description: >-
            The Express accountToken. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-token
          required: true
          type: string
        - description: >-
            A unique ID for this request. This value should be a UUID or GUID.
            <a href='https://triposcert.vantiv.com/api/help/kb/requestid.html'>more&raquo;</a>
          in: header
          name: tp-request-id
          required: true
          type: string
        - description: Set to true to have logs populated in the response.
          in: header
          name: tp-return-logs
          required: false
          type: boolean
        - default: application/json
          description: Content type for request.
          in: header
          name: Content-Type
          required: true
          type: string
        - in: body
          name: CreatePaymetricTokenWithTransIdRequest
          required: false
          schema:
            $ref: >-
              #/definitions/POST_CreatePaymetricTokenWithTransIdRequest_v1_token_paymetric_transactionId
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/CreatePaymetricTokenResponse'
        '401':
          description: >-
            Returned if the AcceptorId, AccountId, AccountToken and TerminalId
            (config file only) are not provided in the HTTP request header or in
            the config file.
        '500':
          description: The token could not be created with the transaction ID given.
      tags:
        - Token
      operationId: postv1tokenpaymetrictransactionId
      summary: Creates a Paymetric token based on a previous transaction ID
  /api/v1/token/worldpay:
    post:
      parameters:
        - description: The ID of the business application.
          in: header
          name: tp-application-id
          required: true
          type: string
        - description: The name of the business application.
          in: header
          name: tp-application-name
          required: true
          type: string
        - description: The version of the business application.
          in: header
          name: tp-application-version
          required: true
          type: string
        - description: The authorization header.
          in: header
          name: tp-authorization
          required: true
          type: string
        - description: >-
            The Express acceptorId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-acceptor-id
          required: true
          type: string
        - description: >-
            The Express accountId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-id
          required: true
          type: string
        - description: >-
            The Express accountToken. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-token
          required: true
          type: string
        - description: >-
            A unique ID for this request. This value should be a UUID or GUID.
            <a href='https://triposcert.vantiv.com/api/help/kb/requestid.html'>more&raquo;</a>
          in: header
          name: tp-request-id
          required: true
          type: string
        - description: Set to true to have logs populated in the response.
          in: header
          name: tp-return-logs
          required: false
          type: boolean
        - default: application/json
          description: Content type for request.
          in: header
          name: Content-Type
          required: true
          type: string
        - in: body
          name: CreateWorldpayTokenRequest
          required: false
          schema:
            $ref: '#/definitions/POST_CreateWorldpayTokenRequest_v1_token_worldpay'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/CreateWorldpayTokenResponse'
        '401':
          description: >-
            Returned if the AcceptorId, AccountId, AccountToken and TerminalId
            (config file only) are not provided in the HTTP request header or in
            the config file.
        '500':
          description: The token could not be created with the card used.
      tags:
        - Token
      description: This endpoint is for swipe capable worldpay token creation.
      operationId: postv1tokenworldpay
      summary: Creates a Worldpay token based on a card swipe
  /api/v1/transactionQuery:
    post:
      parameters:
        - description: The ID of the business application.
          in: header
          name: tp-application-id
          required: true
          type: string
        - description: The name of the business application.
          in: header
          name: tp-application-name
          required: true
          type: string
        - description: The version of the business application.
          in: header
          name: tp-application-version
          required: true
          type: string
        - description: The authorization header.
          in: header
          name: tp-authorization
          required: true
          type: string
        - description: >-
            The Express acceptorId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-acceptor-id
          required: true
          type: string
        - description: >-
            The Express accountId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-id
          required: true
          type: string
        - description: >-
            The Express accountToken. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-token
          required: true
          type: string
        - description: >-
            A unique ID for this request. This value should be a UUID or GUID.
            <a href='https://triposcert.vantiv.com/api/help/kb/requestid.html'>more&raquo;</a>
          in: header
          name: tp-request-id
          required: true
          type: string
        - description: Set to true to have logs populated in the response.
          in: header
          name: tp-return-logs
          required: false
          type: boolean
        - default: application/json
          description: Content type for request.
          in: header
          name: Content-Type
          required: true
          type: string
        - in: body
          name: TransactionQueryRequest
          required: false
          schema:
            $ref: '#/definitions/POST_TransactionQueryRequest_v1_transactionQuery'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/TransactionQueryResponse'
        '401':
          description: >-
            Returned if the AcceptorId, AccountId, AccountToken and TerminalId
            (config file only) are not provided in the HTTP request header or in
            the config file.
      tags:
        - TransactionQuery
      description: Gets a transaction details based on the passed in parameters
      operationId: postv1transactionQuery
      summary: Gets a transaction details based on the passed in parameters
  '/api/v1/void/{transactionId}':
    post:
      parameters:
        - description: The ID of a previous transaction.
          in: path
          name: transactionId
          required: true
          type: string
        - description: The ID of the business application.
          in: header
          name: tp-application-id
          required: true
          type: string
        - description: The name of the business application.
          in: header
          name: tp-application-name
          required: true
          type: string
        - description: The version of the business application.
          in: header
          name: tp-application-version
          required: true
          type: string
        - description: The authorization header.
          in: header
          name: tp-authorization
          required: true
          type: string
        - description: >-
            The Express acceptorId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-acceptor-id
          required: true
          type: string
        - description: >-
            The Express accountId. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-id
          required: true
          type: string
        - description: >-
            The Express accountToken. If all three Express credentials are
            specified in the request headers, triPOS will use these credentials
            instead of the credentials in the triPOS.config for that request
            only.
          in: header
          name: tp-express-account-token
          required: true
          type: string
        - description: >-
            A unique ID for this request. This value should be a UUID or GUID.
            <a href='https://triposcert.vantiv.com/api/help/kb/requestid.html'>more&raquo;</a>
          in: header
          name: tp-request-id
          required: true
          type: string
        - description: Set to true to have logs populated in the response.
          in: header
          name: tp-return-logs
          required: false
          type: boolean
        - default: application/json
          description: Content type for request.
          in: header
          name: Content-Type
          required: true
          type: string
        - in: body
          name: VoidRequest
          required: false
          schema:
            $ref: '#/definitions/POST_VoidRequest_v1_void_transactionId'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/VoidResponse'
        '401':
          description: >-
            Returned if the AcceptorId, AccountId, AccountToken and TerminalId
            (config file only) are not provided in the HTTP request header or in
            the config file.
      tags:
        - Void
      operationId: postv1voidtransactionId
      summary: Voids the previous transaction with the passed in transaction ID
definitions:
  ActivateGiftRequest:
    description: ActivateGiftRequest
    properties:
      cardHolderPresentCode:
        description: >-
          Defines whether the cardholder is present at the transaction. This
          value is optional, but recommended to be set. If this value is not set
          in the request, it will be automatically set based on the market code.
        type: string
      clerkNumber:
        description: An optional clerk number for reference.
        type: string
      configuration:
        $ref: '#/definitions/POST_RequestConfiguration_v1_gift_activate'
        description: >-
          Any value included in this section will override the corresponding
          value set in the triPOS.config
      giftCardProgram:
        description: >-
          This field is for Valutec gift/loyalty card program. <br>'01' =
          Original Gift Card Program <br>'02' = Promotional Gift Card Program
          <br>'03' = Original Combo Card Program <br>'04' = Auto Rewards LPR
          Card Program <br>'05' = Original Loyalty Card Program
        type: string
      giftProgramType:
        description: >-
          This field is for Valutec gift/loyalty card type. The value 0 is for
          gift and 1 for loyalty
        type: string
      invokeManualEntry:
        description: ' Invokes manual card entry.'
        type: boolean
      isCscSupported:
        description: >-
          Invokes prompt for cardholder to enter card security code for manual
          keyed card entry.
        type: string
      laneId:
        description: Specifies which lane to use.
        format: int32
        type: integer
      referenceNumber:
        description: A user defined reference number.
        type: string
      shiftId:
        description: An optional shift id for reference.
        type: string
      storeCard:
        $ref: '#/definitions/POST_StoreCard_v1_gift_activate'
        description: Information necessary to process a StoreCard transaction.
      ticketNumber:
        description: An optional ticket number.
        type: string
      transactionAmount:
        description: >-
          The total transaction amount. This is the amount of funds to move on
          the card
        format: double
        type: number
    required:
      - laneId
      - transactionAmount
  ActivateGiftResponse:
    description: ActivateGiftResponse
    properties:
      _errors:
        description: A list of errors that occurred.
        items:
          $ref: '#/definitions/ApiError'
        type: array
      _hasErrors:
        description: Indicates if there are errors.
        type: boolean
      _links:
        description: A list of resource links
        items:
          $ref: '#/definitions/ApiLink'
        type: array
      _logs:
        description: >-
          A list of log entries detailing what happened during the request.
          Ideally only used during development or troubleshooting as this can be
          quite verbose.
        items:
          type: string
        type: array
      _processor:
        $ref: '#/definitions/Processor'
        description: Response information from the processor.
      _type:
        description: The type of object held in the result.
        type: string
      _warnings:
        description: A list of warnings that occurred.
        items:
          $ref: '#/definitions/ApiWarning'
        type: array
      accountNumber:
        description: The card account number.
        type: string
      approvalNumber:
        description: >-
          Approval number from the processor. Depending on card type and
          processor an approval number might not be returned.
        type: string
      approvedAmount:
        description: The amount approved for the transaction.
        format: double
        type: number
      balanceAmount:
        description: The balance of the gift card.
        format: double
        type: number
      balanceCurrencyCode:
        description: The balance currency code.
        type: string
      binAttributes:
        $ref: '#/definitions/Dictionary_String_Boolean'
        description: >-
          Available binAttributes of card. <a
          href='https://triposcert.vantiv.com/api/help/kb/cardBinAttributes.html'>more&raquo;</a>
      binValue:
        description: The BIN entry that matched the account number.
        type: string
      cardLogo:
        description: 'The card logo (e.g. Visa, Mastercard, etc).'
        type: string
      entryMode:
        description: 'Description of how card was entered: Keyed, Swiped, Chip.'
        type: string
      giftPointsBalance:
        description: >-
          This field provides gift points balance for Valutec gift/loyalty
          cards.
        type: string
      giftRewardLevel:
        description: This field provides gift reward level for Valutec gift/loyalty cards.
        type: string
      isApproved:
        description: Set to true if the host approved the transaction.
        type: boolean
      isOffline:
        description: >-
          A boolean value indicating whether triPOS is disconnected from the
          host.
        type: boolean
      merchantId:
        description: The Merchant used to process the transaction.
        type: string
      statusCode:
        description: The status code for the transaction.
        type: string
      terminalId:
        description: The ID of the terminal used during the transaction
        type: string
      totalAmount:
        description: The total amount of the transaction.
        format: double
        type: number
      transactionDateTime:
        description: Transaction date/time in ISO8601 format
        type: string
      transactionId:
        description: The transaction ID from the processor
        type: string
  Address:
    description: Address
    properties:
      billingAddress1:
        description: The street address used for billing purposes.
        type: string
      billingAddress2:
        description: The street address used for billing purposes.
        type: string
      billingCity:
        description: The name of the city used for billing purposes.
        type: string
      billingEmail:
        description: The e-mail address used for billing purposes.
        type: string
      billingName:
        description: The name used for billing purposes.
        type: string
      billingPhone:
        description: >-
          The phone number used for billing purposes. The recommended format is
          (800)555-1212.
        type: string
      billingPostalCode:
        description: The postal code used for billing purposes.
        type: string
      billingState:
        description: >-
          The name of the state used for billing purposes. This value may be any
          2 character state code or the full state name.
        type: string
      shippingAddress1:
        description: The street address used for shipping purposes.
        type: string
      shippingAddress2:
        description: The street address used for shipping purposes.
        type: string
      shippingCity:
        description: The name of the city used for shipping purposes.
        type: string
      shippingEmail:
        description: The e-mail address used for shipping purposes.
        type: string
      shippingName:
        description: The name used for shipping purposes.
        type: string
      shippingPhone:
        description: >-
          The phone number used for shipping purposes. The recommended format is
          (800)555-1212
        type: string
      shippingPostalCode:
        description: The postal code used for shipping purposes.
        type: string
      shippingState:
        description: >-
          The name of the state used for shipping purposes. This value may be
          any 2 character state code or the full state name.
        type: string
  ApiError:
    description: ApiError
    properties:
      developerMessage:
        description: >-
          An error message targeted at the developer of the integrated business
          application.
        type: string
      errorType:
        description: Code associated with the error if it exists.
        type: string
      exceptionMessage:
        description: The body of the exception message.
        type: string
      exceptionTypeFullName:
        description: The full name of the exception.
        type: string
      exceptionTypeShortName:
        description: The short name of the exception.
        type: string
      userMessage:
        description: >-
          An error message targeted at the end user of the integrated business
          application.
        type: string
  ApiLink:
    description: ApiLink
    properties:
      href:
        description: A target (a URI)
        type: string
      method:
        description: The HTTP method to access the HREF target
        type: string
      rel:
        description: The relation aka. 'rel' (the name of the link)
        type: string
  ApiWarning:
    description: ApiWarning
    properties:
      developerMessage:
        description: >-
          A warning message targeted at the developer of the integrated business
          application.
        type: string
      userMessage:
        description: >-
          A warning message targeted at the end user of the integrated business
          application.
        type: string
  AuthorizationCompletionRequest:
    description: AuthorizationCompletionRequest
    properties:
      address:
        $ref: '#/definitions/POST_Address_v1_authorization_transactionId_completion'
        description: The cardholder address information for the transaction.
      autoRental:
        $ref: >-
          #/definitions/POST_AutoRental_v1_authorization_transactionId_completion
        description: >-
          The auto rental parameters to be passed in for an auto rental
          transaction. <a href='https://triposcert.vantiv.com/api/help/kb/autorental.html'>more&raquo;</a>
      cardHolderPresentCode:
        description: >-
          Defines whether the cardholder is present at the transaction. This
          value is optional, but recommended to be set. If this value is not set
          in the request, it will be automatically set based on the market code.
        type: string
      clerkNumber:
        description: An optional clerk number for reference.
        type: string
      commercialCardCustomerCode:
        description: >-
          The commercial card customer code for the transaction. This is for
          Level II.
        type: string
      configuration:
        $ref: >-
          #/definitions/POST_AuthorizationCompletionRequestConfiguration_v1_authorization_transactionId_completion
        description: >-
          Any value included in this section will override the corresponding
          value set in the triPOS.config
      convenienceFeeAmount:
        description: >-
          The convenience fee amount of the transaction. This amount is added to
          the TotalAmount before the cardholder is charged
        format: double
        type: number
      laneId:
        description: Specifies which lane to use.
        format: int32
        type: integer
      lodging:
        $ref: >-
          #/definitions/POST_LodgingTransactionCompletion_v1_authorization_transactionId_completion
        description: >-
          The lodging parameters to be passed in for a lodging transaction. <a
          href='https://triposcert.vantiv.com/api/help/kb/lodging.html'>more&raquo;</a>
      networkTransactionID:
        description: >-
          The card brand specific transaction ID that should be stored by the
          integrator.
        type: string
      recurringPaymentType:
        description: Intent of why the credentials are being stored.
        type: string
      referenceNumber:
        description: A user defined reference number.
        type: string
      salesTaxAmount:
        description: >-
          The amount of sales tax for the transaction. This is for Level II,
          submit amount for tax or 0.00 for tax-exempt.
        format: double
        type: number
      shiftId:
        description: An optional shift id for reference.
        type: string
      submissionType:
        description: Specifies the type of transaction.
        type: string
      ticketNumber:
        description: An optional ticket number.
        type: string
      tipAmount:
        description: >-
          The tip amount of the transaction. This amount is added to the
          TotalAmount before the cardholder is charged.
        format: double
        type: number
      transactionAmount:
        description: >-
          The total transaction amount. This is the amount of funds to move on
          the card
        format: double
        type: number
    required:
      - laneId
      - transactionAmount
  AuthorizationCompletionRequestConfiguration:
    description: AuthorizationCompletionRequestConfiguration
    properties:
      allowPartialApprovals:
        description: 'If set to false, partial approvals are not allowed'
        type: boolean
      cardReadRetries:
        description: "Number of retries in case of bad card read. The\_default\_value\_is\_1."
        format: int32
        type: integer
      checkForDuplicateTransactions:
        description: >-
          If set to true, enables duplicate checking logic for the transaction
          at the host.
        type: boolean
      isManualEntryAllowed:
        description: >-
          Use this parameter to allow manual entry of card account numbers on
          the PIN pad.
        type: string
      marketCode:
        description: 'The market code of the transaction. '
        type: string
      promptForSignature:
        description: >-
          Specifies how the signature prompt should be handled for the request.
          If a value is not provided, Never will be used. See <a
          href='https://triposcert.vantiv.com/api/help/kb/signaturePrompt.html'>Signature Prompt</a>.
        type: string
      provisionalAmount:
        description: >-
          Override provisional amount used for QC transactions, which is $1.00
          by default
        type: string
      userInputTimeout:
        description: Specifies the user input timeout.
        type: string
  AuthorizationCompletionResponse:
    description: AuthorizationCompletionResponse
    properties:
      _errors:
        description: A list of errors that occurred.
        items:
          $ref: '#/definitions/ApiError'
        type: array
      _hasErrors:
        description: Indicates if there are errors.
        type: boolean
      _links:
        description: A list of resource links
        items:
          $ref: '#/definitions/ApiLink'
        type: array
      _logs:
        description: >-
          A list of log entries detailing what happened during the request.
          Ideally only used during development or troubleshooting as this can be
          quite verbose.
        items:
          type: string
        type: array
      _processor:
        $ref: '#/definitions/Processor'
        description: Response information from the processor.
      _type:
        description: The type of object held in the result.
        type: string
      _warnings:
        description: A list of warnings that occurred.
        items:
          $ref: '#/definitions/ApiWarning'
        type: array
      accountNumber:
        description: The card account number.
        type: string
      accountType:
        description: The account type selected and used in the transaction.
        type: string
      approvalNumber:
        description: >-
          Approval number from the processor. Depending on card type and
          processor an approval number might not be returned.
        type: string
      approvedAmount:
        description: >-
          The amount approved by the processor. This is the actual amount that
          will be charged or credited.
        format: double
        type: number
      balanceAmount:
        description: The balance of the gift card.
        format: double
        type: number
      balanceCurrencyCode:
        description: The balance currency code.
        type: string
      binAttributes:
        $ref: '#/definitions/Dictionary_String_Boolean'
        description: >-
          Available binAttributes of card. <a
          href='https://triposcert.vantiv.com/api/help/kb/cardBinAttributes.html'>more&raquo;</a>
      binValue:
        description: The BIN entry that matched the account number.
        type: string
      cardHolderName:
        description: The cardholder name.
        type: string
      cardLogo:
        description: >-
          The card logo. Possible values are: Visa, Mastercard, Discover, Amex,
          Diners Club, JCB, Carte Blanche, Other.
        type: string
      convenienceFeeAmount:
        description: The convenience fee added to the transaction
        format: double
        type: number
      conversionRate:
        description: Conversion rate for the ForeignCurrencyCode.
        type: string
      countryCode:
        description: The country code used in the transaction.
        type: string
      creditSurchargeAmount:
        description: The surcharge amount that was added to the transaction.
        format: double
        type: number
      currencyCode:
        description: The currency code used in the transaction.
        type: string
      driverID:
        description: Fleet DriverID Input On The Device
        type: string
      ebtType:
        description: The type of the EBT card
        type: string
      emv:
        $ref: '#/definitions/Emv'
        description: >-
          The fields used on the receipt for an EMV transaction. Null if the
          transaction was not EMV.
      entryMode:
        description: Description of how card was entered.
        type: string
      expirationMonth:
        description: The card's expiration month
        type: string
      expirationYear:
        description: The card's expiration year
        type: string
      fleetAdditionalPromptedData1:
        description: Fleet Additional Prompted Data1 Input On The Device
        type: string
      fleetAdditionalPromptedData2:
        description: Fleet Additional Prompted Data2 Input On The Device
        type: string
      fleetEmployeeNumber:
        description: Fleet Employee Number Input On The Device
        type: string
      fleetJobNumber:
        description: Fleet Job Number Input On The Device
        type: string
      fleetTrailerNumber:
        description: Fleet Trailer Number Input On The Device
        type: string
      fleetUserID:
        description: Fleet UserID Input On The Device
        type: string
      foreignCurrencyCode:
        description: Currency code of the foreign currency.
        type: string
      foreignTransactionAmount:
        description: Transaction amount shown in the foreign currency.
        type: string
      fsaCard:
        description: >-
          Indicates whether the card used was a FSA card.<br />Note: Maybe = No
          BIN entry to determine if FSA.
        type: string
      isApproved:
        description: Set to true if the host approved the transaction.
        type: boolean
      isCardInserted:
        description: >-
          Indicates whether the EMV card was still inserted into the payment
          device when the transaction completed.
        type: boolean
      isFleetOdometerPrint:
        description: is Fleet Odometer value Print On the Receipt or not
        type: boolean
      isOffline:
        description: >-
          A boolean value indicating whether triPOS is disconnected from the
          host.
        type: boolean
      language:
        description: The language used in the transaction.
        type: string
      merchantId:
        description: The Merchant used to process the transaction.
        type: string
      networkLabel:
        description: >-
          Label that shows the network where the transaction was routed for
          authorization
        type: string
      nonFinancialData:
        $ref: '#/definitions/NonFinancialCard'
        description: Non Financial data.
      odometer:
        description: Fleet Odometer Input On The Device
        type: string
      paymentType:
        description: Description of payment type utilized.
        type: string
      pinVerified:
        description: 'True if the PIN was verified, false if not verified or undetermined.'
        type: boolean
      preReadId:
        $ref: '#/definitions/Guid'
        description: >-
          Unique ID. If checkForPreReadId field is true, then this ID will be
          required for the Quick Chip portion of the transaction to be
          successful.
      purchaseDeviceSequenceNumber:
        description: Fleet Purchase Device Sequence Number from the card
        type: string
      quickChipMessage:
        description: The message unique to QuickChip pre-read functionality only.
        type: string
      signature:
        $ref: '#/definitions/Signature'
        description: The signature data.
      statusCode:
        description: The status code for the transaction.
        type: string
      subTotalAmount:
        description: The original amount sent for the transaction.
        format: double
        type: number
      terminalId:
        description: The ID of the terminal used during the transaction
        type: string
      tipAmount:
        description: The tip amount added to the transaction.
        format: double
        type: number
      tokenId:
        description: The Token ID.
        type: string
      tokenProvider:
        description: The Token Provider.
        type: string
      totalAmount:
        description: The total amount of the transaction.
        format: double
        type: number
      transactionDateTime:
        description: Transaction date/time in ISO8601 format
        type: string
      transactionId:
        description: The transaction ID from the processor
        type: string
      transactionStored:
        description: >-
          Indicates the transaction was not able to be processed online and was
          stored instead. This is currently only applicable for Mobile device.
        type: boolean
      vehicleID:
        description: Fleet Vehicle ID Input On The Device
        type: string
  AuthorizationRequest:
    description: AuthorizationRequest
    properties:
      address:
        $ref: '#/definitions/POST_Address_v1_authorization'
        description: The cardholder address information for the transaction.
      autoRental:
        $ref: '#/definitions/POST_AutoRentalBasic_v1_authorization'
        description: >-
          The auto rental parameters to be passed in for an auto rental
          transaction. <a href='https://triposcert.vantiv.com/api/help/kb/autorental.html'>more&raquo;</a>
      cardHolderPresentCode:
        description: >-
          Defines whether the cardholder is present at the transaction. This
          value is optional, but recommended to be set. If this value is not set
          in the request, it will be automatically set based on the market code.
        type: string
      checkForPreReadId:
        description: >-
          Flag to support 'PreReadId feature in quick chip' transaction request.
          This will take precedence over triPOS.config flag.
        type: boolean
      clerkNumber:
        description: An optional clerk number for reference.
        type: string
      commercialCardCustomerCode:
        description: >-
          The commercial card customer code for the transaction. This is for
          Level II.
        type: string
      configuration:
        $ref: '#/definitions/POST_AuthorizationRequestConfiguration_v1_authorization'
        description: >-
          Any value included in this section will override the corresponding
          value set in the triPOS.config
      convenienceFeeAmount:
        description: >-
          The convenience fee amount of the transaction. This amount is added to
          the TotalAmount before the cardholder is charged
        format: double
        type: number
      creditSurchargeAmount:
        description: >-
          The credit surcharge amount of the transaction. This amount is added
          to the TotalAmount before the cardholder is charged. <a
          href='https://triposcert.vantiv.com/api/help/kb/cloud/Surcharging.html'>more&raquo;</a>
        format: double
        type: number
      displayTransactionAmount:
        description: Display the transaction amount during card read.
        type: boolean
      estimatedAmountIndicator:
        description: >-
          The EstimatedAmountIndicator can be used by merchants/integrators to
          define the TransactionAmount submitted to Express either as an
          Estimated Amount (i.e. amount to charge cardholder may change) or a
          Final Amount (i.e. amount to charge cardholder will not change).  It
          will be a 1-character request field supporting the following request
          settings:
        type: string
      getToken:
        description: >-
          To retrieve Token in the transaction. <a
          href='https://triposcert.vantiv.com/api/help/kb/GetToken.html'>more&raquo;</a>
        type: string
      healthcare:
        $ref: '#/definitions/POST_Healthcare_v1_authorization'
        description: >-
          The healthcare section that contains all applicable
          healthcare-qualified amounts. <a
          href='https://triposcert.vantiv.com/api/help/kb/healthcare.html'>more&raquo;</a>
      invokeManualEntry:
        description: ' Invokes manual card entry.'
        type: boolean
      isCscSupported:
        description: >-
          Invokes prompt for cardholder to enter card security code for manual
          keyed card entry.
        type: string
      laneId:
        description: Specifies which lane to use.
        format: int32
        type: integer
      lodging:
        $ref: '#/definitions/POST_LodgingAuthorization_v1_authorization'
        description: >-
          The lodging parameters to be passed in for a lodging transaction. <a
          href='https://triposcert.vantiv.com/api/help/kb/lodging.html'>more&raquo;</a>
      networkTransactionID:
        description: >-
          The card brand specific transaction ID that should be stored by the
          integrator.
        type: string
      nonFinancialExpected:
        description: >-
          Non Financial Card read Expected. Only supported on unattended
          devices.
        type: boolean
      preRead:
        description: >-
          Flag indicating desire to process authorization as PreRead (i.e. - do
          ONLY Pre-Read operations, then expecting next endpoint call to be
          QuickChip) <a
          href='https://triposcert.vantiv.com/api/help/kb/cloud/QuickChipConfiguration.html'>more&raquo;</a>.
        type: boolean
      preReadId:
        $ref: '#/definitions/POST_Guid_v1_authorization'
        description: >-
          A unique ID for this request. This value should be a GUID.<a
          href='..\help\kb\QuickChipWithPreReadId.html'>more&raquo;</a>.
      quickChip:
        description: >-
          Flag indicating desire to process authorization as QuickChip (i.e. -
          Pre-Read has been previously performed) <a
          href='https://triposcert.vantiv.com/api/help/kb/cloud/QuickChipConfiguration.html'>more&raquo;</a>.
        type: boolean
      recurringPaymentType:
        description: 'Recurring PaymentType,Intent of why the credentials are being stored.'
        type: string
      referenceNumber:
        description: A user defined reference number.
        type: string
      salesTaxAmount:
        description: >-
          The amount of sales tax for the transaction. This is for Level II,
          submit amount for tax or 0.00 for tax-exempt.
        format: double
        type: number
      shiftId:
        description: An optional shift id for reference.
        type: string
      submissionType:
        description: 'SubmissionType,Initial vs Subsequent Transaction.'
        type: string
      ticketNumber:
        description: An optional ticket number.
        type: string
      tipAmount:
        description: >-
          The tip amount of the transaction. This amount is added to the
          TotalAmount before the cardholder is charged.
        format: double
        type: number
      transactionAmount:
        description: >-
          The total transaction amount. This is the amount of funds to move on
          the card
        type: string
    required:
      - laneId
      - transactionAmount
  AuthorizationRequestConfiguration:
    description: AuthorizationRequestConfiguration
    properties:
      allowPartialApprovals:
        description: 'If set to false, partial approvals are not allowed'
        type: boolean
      cardReadRetries:
        description: "Number of retries in case of bad card read. The\_default\_value\_is\_1."
        format: int32
        type: integer
      checkForDuplicateTransactions:
        description: >-
          If set to true, enables duplicate checking logic for the transaction
          at the host.
        type: boolean
      isManualEntryAllowed:
        description: >-
          Use this parameter to allow manual entry of card account numbers on
          the PIN pad.
        type: string
      marketCode:
        description: 'The market code of the transaction. '
        type: string
      promptForSignature:
        description: >-
          Specifies how the signature prompt should be handled for the request.
          If a value is not provided, Never will be used. See <a
          href='https://triposcert.vantiv.com/api/help/kb/signaturePrompt.html'>Signature Prompt</a>.
        type: string
      provisionalAmount:
        description: >-
          Override provisional amount used for QC transactions, which is $1.00
          by default
        type: string
      userInputTimeout:
        description: Specifies the user input timeout.
        type: string
  AuthorizationResponse:
    description: AuthorizationResponse
    properties:
      _errors:
        description: A list of errors that occurred.
        items:
          $ref: '#/definitions/ApiError'
        type: array
      _hasErrors:
        description: Indicates if there are errors.
        type: boolean
      _links:
        description: A list of resource links
        items:
          $ref: '#/definitions/ApiLink'
        type: array
      _logs:
        description: >-
          A list of log entries detailing what happened during the request.
          Ideally only used during development or troubleshooting as this can be
          quite verbose.
        items:
          type: string
        type: array
      _processor:
        $ref: '#/definitions/Processor'
        description: Response information from the processor.
      _type:
        description: The type of object held in the result.
        type: string
      _warnings:
        description: A list of warnings that occurred.
        items:
          $ref: '#/definitions/ApiWarning'
        type: array
      accountNumber:
        description: The card account number.
        type: string
      accountType:
        description: The account type selected and used in the transaction.
        type: string
      approvalNumber:
        description: >-
          Approval number from the processor. Depending on card type and
          processor an approval number might not be returned.
        type: string
      approvedAmount:
        description: >-
          The amount approved by the processor. This is the actual amount that
          will be charged or credited.
        format: double
        type: number
      balanceAmount:
        description: The balance of the gift card.
        format: double
        type: number
      balanceCurrencyCode:
        description: The balance currency code.
        type: string
      binAttributes:
        $ref: '#/definitions/Dictionary_String_Boolean'
        description: >-
          Available binAttributes of card. <a
          href='https://triposcert.vantiv.com/api/help/kb/cardBinAttributes.html'>more&raquo;</a>
      binValue:
        description: The BIN entry that matched the account number.
        type: string
      cardHolderName:
        description: The cardholder name.
        type: string
      cardLogo:
        description: >-
          The card logo. Possible values are: Visa, Mastercard, Discover, Amex,
          Diners Club, JCB, Carte Blanche, Other.
        type: string
      convenienceFeeAmount:
        description: The convenience fee added to the transaction
        format: double
        type: number
      conversionRate:
        description: Conversion rate for the ForeignCurrencyCode.
        type: string
      countryCode:
        description: The country code used in the transaction.
        type: string
      creditSurchargeAmount:
        description: The surcharge amount that was added to the transaction.
        format: double
        type: number
      currencyCode:
        description: The currency code used in the transaction.
        type: string
      driverID:
        description: Fleet DriverID Input On The Device
        type: string
      ebtType:
        description: The type of the EBT card
        type: string
      emv:
        $ref: '#/definitions/Emv'
        description: >-
          The fields used on the receipt for an EMV transaction. Null if the
          transaction was not EMV.
      entryMode:
        description: Description of how card was entered.
        type: string
      expirationMonth:
        description: The card's expiration month
        type: string
      expirationYear:
        description: The card's expiration year
        type: string
      fleetAdditionalPromptedData1:
        description: Fleet Additional Prompted Data1 Input On The Device
        type: string
      fleetAdditionalPromptedData2:
        description: Fleet Additional Prompted Data2 Input On The Device
        type: string
      fleetEmployeeNumber:
        description: Fleet Employee Number Input On The Device
        type: string
      fleetJobNumber:
        description: Fleet Job Number Input On The Device
        type: string
      fleetTrailerNumber:
        description: Fleet Trailer Number Input On The Device
        type: string
      fleetUserID:
        description: Fleet UserID Input On The Device
        type: string
      foreignCurrencyCode:
        description: Currency code of the foreign currency.
        type: string
      foreignTransactionAmount:
        description: Transaction amount shown in the foreign currency.
        type: string
      fsaCard:
        description: >-
          Indicates whether the card used was a FSA card.<br />Note: Maybe = No
          BIN entry to determine if FSA.
        type: string
      isApproved:
        description: Set to true if the host approved the transaction.
        type: boolean
      isCardInserted:
        description: >-
          Indicates whether the EMV card was still inserted into the payment
          device when the transaction completed.
        type: boolean
      isFleetOdometerPrint:
        description: is Fleet Odometer value Print On the Receipt or not
        type: boolean
      isOffline:
        description: >-
          A boolean value indicating whether triPOS is disconnected from the
          host.
        type: boolean
      language:
        description: The language used in the transaction.
        type: string
      merchantId:
        description: The Merchant used to process the transaction.
        type: string
      networkLabel:
        description: >-
          Label that shows the network where the transaction was routed for
          authorization
        type: string
      networkTransactionId:
        description: >-
          The card brand specific transaction ID that should be stored by the
          integrator.
        type: string
      nonFinancialData:
        $ref: '#/definitions/NonFinancialCard'
        description: Non Financial data.
      odometer:
        description: Fleet Odometer Input On The Device
        type: string
      paymentType:
        description: Description of payment type utilized.
        type: string
      pinVerified:
        description: 'True if the PIN was verified, false if not verified or undetermined.'
        type: boolean
      preReadId:
        $ref: '#/definitions/Guid'
        description: >-
          Unique ID. If checkForPreReadId field is true, then this ID will be
          required for the Quick Chip portion of the transaction to be
          successful.
      purchaseDeviceSequenceNumber:
        description: Fleet Purchase Device Sequence Number from the card
        type: string
      quickChipMessage:
        description: The message unique to QuickChip pre-read functionality only.
        type: string
      signature:
        $ref: '#/definitions/Signature'
        description: The signature data.
      statusCode:
        description: The status code for the transaction.
        type: string
      subTotalAmount:
        description: The original amount sent for the transaction.
        format: double
        type: number
      terminalId:
        description: The ID of the terminal used during the transaction
        type: string
      tipAmount:
        description: The tip amount added to the transaction.
        format: double
        type: number
      tokenId:
        description: The Token ID.
        type: string
      tokenProvider:
        description: The Token Provider.
        type: string
      totalAmount:
        description: The total amount of the transaction.
        format: double
        type: number
      transactionDateTime:
        description: Transaction date/time in ISO8601 format
        type: string
      transactionId:
        description: The transaction ID from the processor
        type: string
      transactionStored:
        description: >-
          Indicates the transaction was not able to be processed online and was
          stored instead. This is currently only applicable for Mobile device.
        type: boolean
      vehicleID:
        description: Fleet Vehicle ID Input On The Device
        type: string
  AutoRental:
    description: AutoRental
    properties:
      adjustmentData:
        $ref: >-
          #/definitions/POST_AutoRentalAdjustmentData_v1_authorization_transactionId_completion
        description: Data related to any auto rental adjustments.
      agreementNumber:
        description: Agreement number.
        type: string
      customerName:
        description: Customer Name.
        type: string
      dailyRentalRate:
        description: >-
          Rate charged per day Visa/MC – Daily rate required for Corp T&E rate
          III.
        format: double
        type: number
      duration:
        description: >-
          The number of rental days. Value should be between 0 and 99. Set to 01
          for no show rentals.
        format: int32
        type: integer
      insuranceCharges:
        description: 'If insurance is charged, the insurance amount should be provided.'
        format: double
        type: number
      noShowIndicator:
        description: >-
          No show indicator. Indicates whether rental vehicle was reserved, but
          not actually rented.
        type: string
      pickupData:
        $ref: >-
          #/definitions/POST_AutoRentalPickupData_v1_authorization_transactionId_completion
        description: Data related to autorental pickup.
      returnData:
        $ref: >-
          #/definitions/POST_AutoRentalReturnData_v1_authorization_transactionId_completion
        description: Data related to autorental return.
      vehicleClassCode:
        description: Classification of rental vehicle
        type: string
      weeklyRentalRate:
        description: >-
          Rate charged per week Visa/MC – Weekly rate required for Corp T&E rate
          III.
        format: double
        type: number
  AutoRentalAdjustmentData:
    description: AutoRentalAdjustmentData
    properties:
      amount:
        description: Adjustment amount.
        format: double
        type: number
      code:
        description: >-
          Indicates if adjustment for mileage, fuel, vehicle damage, etc. was
          made to a rental agreement.
        type: string
      extraChargesDetail:
        description: >-
          Pass in up to 6 values that describe the extra charges. For an empty
          or invalid value, this parameter defaults to NoExtraCharge.
        items:
          enum:
            - NoExtraCharge
            - Gasoline
            - ExtraMileage
            - LateReturn
            - OneWayServiceFee
            - ParkingOrMovingViolation
          type: string
        type: array
  AutoRentalBasic:
    description: AutoRentalBasic
    properties:
      duration:
        description: >-
          The number of rental days. Value should be between 0 and 99. Set to 01
          for no show rentals.
        format: int32
        type: integer
  AutoRentalPickupData:
    description: AutoRentalPickupData
    properties:
      city:
        description: Auto rental pickup city.
        type: string
      countryCode:
        description: 'Country code where vehicle was picked up. For US, use 840.'
        type: string
      date:
        description: 'return date in yyyy-MM-ddTHH:mm:ss format.'
        type: string
      location:
        description: Name of business where vehicle was picked up.
        type: string
      state:
        description: >-
          Abbreviation of state, province, or other country subdivision where
          vehicle was picked up.
        type: string
  AutoRentalReturnData:
    description: AutoRentalReturnData
    properties:
      city:
        description: Auto rental return city.
        type: string
      countryCode:
        description: 'Country code where vehicle was returned. For US, use 840.'
        type: string
      date:
        description: 'return date in yyyy-MM-ddTHH:mm:ss format.'
        type: string
      distance:
        description: Numeric distance traveled during rental period.
        format: int32
        type: integer
      distanceUnit:
        description: Unit of measurement applicable to distance traveled.
        type: string
      locationId:
        description: Auto Rental location ID where vehicle was returned.
        type: string
      state:
        description: Auto rental return state.
        type: string
  BalanceRequest:
    description: BalanceRequest
    properties:
      cardHolderPresentCode:
        description: >-
          Defines whether the cardholder is present at the transaction. This
          value is optional, but recommended to be set. If this value is not set
          in the request, it will be automatically set based on the market code.
        type: string
      clerkNumber:
        description: An optional clerk number for reference.
        type: string
      configuration:
        $ref: '#/definitions/POST_RequestConfiguration_v1_balance'
        description: >-
          Any value included in this section will override the corresponding
          value set in the triPOS.config
      ebtType:
        description: EbtType may be FoodStamp or CashBenefit
        type: string
      giftCardProgram:
        description: >-
          This field is for Valutec gift/loyalty card program. <br>'01' =
          Original Gift Card Program <br>'02' = Promotional Gift Card Program
          <br>'03' = Original Combo Card Program <br>'04' = Auto Rewards LPR
          Card Program <br>'05' = Original Loyalty Card Program
        type: string
      giftProgramType:
        description: >-
          This field is for Valutec gift/loyalty card type. The value 0 is for
          gift and 1 for loyalty
        type: string
      invokeManualEntry:
        description: Invokes manual card entry.
        type: boolean
      isCscSupported:
        description: >-
          Invokes prompt for cardholder to enter card security code for manual
          keyed card entry.
        type: string
      isGiftSupported:
        description: Allows to use gift card functionality
        type: string
      laneId:
        description: Specifies which lane to use.
        format: int32
        type: integer
      referenceNumber:
        description: A user defined reference number.
        type: string
      shiftId:
        description: An optional shift id for reference.
        type: string
      storeCard:
        $ref: '#/definitions/POST_StoreCard_v1_balance'
        description: Information necessary to process a StoreCard transaction.
      ticketNumber:
        description: An optional ticket number.
        type: string
    required:
      - laneId
  BalanceResponse:
    description: BalanceResponse
    properties:
      _errors:
        description: A list of errors that occurred.
        items:
          $ref: '#/definitions/ApiError'
        type: array
      _hasErrors:
        description: Indicates if there are errors.
        type: boolean
      _links:
        description: A list of resource links
        items:
          $ref: '#/definitions/ApiLink'
        type: array
      _logs:
        description: >-
          A list of log entries detailing what happened during the request.
          Ideally only used during development or troubleshooting as this can be
          quite verbose.
        items:
          type: string
        type: array
      _processor:
        $ref: '#/definitions/Processor'
        description: Response information from the processor.
      _type:
        description: The type of object held in the result.
        type: string
      _warnings:
        description: A list of warnings that occurred.
        items:
          $ref: '#/definitions/ApiWarning'
        type: array
      accountNumber:
        description: The card account number.
        type: string
      approvalNumber:
        description: >-
          Approval number from the processor. Depending on card type and
          processor an approval number might not be returned.
        type: string
      balanceAmount:
        description: The balance of the gift card.
        format: double
        type: number
      balanceCurrencyCode:
        description: The balance currency code.
        type: string
      binAttributes:
        $ref: '#/definitions/Dictionary_String_Boolean'
        description: >-
          Available binAttributes of card. <a
          href='https://triposcert.vantiv.com/api/help/kb/cardBinAttributes.html'>more&raquo;</a>
      binValue:
        description: The BIN entry that matched the account number.
        type: string
      cardLogo:
        description: 'The card logo (e.g. Visa, Mastercard, etc).'
        type: string
      ebtType:
        description: The type of the EBT card
        type: string
      entryMode:
        description: 'Description of how card was entered: Keyed, Swiped, Chip.'
        type: string
      expirationMonth:
        description: >-
          The card's expiration month. NOTE: Not all cards that support balance
          inquiry will have an expiration date.
        type: string
      expirationYear:
        description: >-
          The card's expiration year. NOTE: Not all cards that support balance
          inquiry will have an expiration date.
        type: string
      giftPointsBalance:
        description: >-
          This field provides gift points balance for Valutec gift/loyalty
          cards.
        type: string
      giftRewardLevel:
        description: This field provides gift reward level for Valutec gift/loyalty cards.
        type: string
      isApproved:
        description: Set to true if the host approved the transaction.
        type: boolean
      isOffline:
        description: >-
          A boolean value indicating whether triPOS is disconnected from the
          host.
        type: boolean
      merchantId:
        description: The Merchant used to process the transaction.
        type: string
      paymentType:
        description: 'Description of how card payment type: None, Credit, Debit.'
        type: string
      statusCode:
        description: The status code for the transaction.
        type: string
      terminalId:
        description: The ID of the terminal used during the transaction
        type: string
      transactionDateTime:
        description: Transaction date/time in ISO8601 format
        type: string
      transactionId:
        description: The transaction ID from the processor
        type: string
  BalanceTransferGiftRequest:
    description: BalanceTransferGiftRequest
    properties:
      alternateCardNumber1:
        description: Gift card number to transfer
        type: string
      alternateCardNumber2:
        description: Second gift card number to transfer
        type: string
      alternateCardNumber3:
        description: Third gift card number to transfer
        type: string
      cardHolderPresentCode:
        description: >-
          Defines whether the cardholder is present at the transaction. This
          value is optional, but recommended to be set. If this value is not set
          in the request, it will be automatically set based on the market code.
        type: string
      clerkNumber:
        description: An optional clerk number for reference.
        type: string
      configuration:
        $ref: '#/definitions/POST_RequestConfiguration_v1_gift_balanceTransfer'
        description: >-
          Any value included in this section will override the corresponding
          value set in the triPOS.config
      giftCardProgram:
        description: >-
          This field is for Valutec gift/loyalty card program. <br>'01' =
          Original Gift Card Program <br>'02' = Promotional Gift Card Program
          <br>'03' = Original Combo Card Program <br>'04' = Auto Rewards LPR
          Card Program <br>'05' = Original Loyalty Card Program
        type: string
      giftProgramType:
        description: >-
          This field is for Valutec gift/loyalty card type. The value 0 is for
          gift and 1 for loyalty
        type: string
      invokeManualEntry:
        description: ' Invokes manual card entry.'
        type: boolean
      isCscSupported:
        description: >-
          Invokes prompt for cardholder to enter card security code for manual
          keyed card entry.
        type: string
      laneId:
        description: Specifies which lane to use.
        format: int32
        type: integer
      referenceNumber:
        description: A user defined reference number.
        type: string
      shiftId:
        description: An optional shift id for reference.
        type: string
      storeCard:
        $ref: '#/definitions/POST_StoreCard_v1_gift_balanceTransfer'
        description: Information necessary to process a StoreCard transaction.
      ticketNumber:
        description: An optional ticket number.
        type: string
      transactionAmount:
        description: >-
          The total transaction amount. This is the amount of funds to move on
          the card
        format: double
        type: number
    required:
      - alternateCardNumber1
      - laneId
      - transactionAmount
  BalanceTransferGiftResponse:
    description: BalanceTransferGiftResponse
    properties:
      _errors:
        description: A list of errors that occurred.
        items:
          $ref: '#/definitions/ApiError'
        type: array
      _hasErrors:
        description: Indicates if there are errors.
        type: boolean
      _links:
        description: A list of resource links
        items:
          $ref: '#/definitions/ApiLink'
        type: array
      _logs:
        description: >-
          A list of log entries detailing what happened during the request.
          Ideally only used during development or troubleshooting as this can be
          quite verbose.
        items:
          type: string
        type: array
      _processor:
        $ref: '#/definitions/Processor'
        description: Response information from the processor.
      _type:
        description: The type of object held in the result.
        type: string
      _warnings:
        description: A list of warnings that occurred.
        items:
          $ref: '#/definitions/ApiWarning'
        type: array
      accountNumber:
        description: The card account number.
        type: string
      approvalNumber:
        description: >-
          Approval number from the processor. Depending on card type and
          processor an approval number might not be returned.
        type: string
      approvedAmount:
        description: The amount approved for the transaction.
        format: double
        type: number
      balanceAmount:
        description: The balance of the gift card.
        format: double
        type: number
      balanceCurrencyCode:
        description: The balance currency code.
        type: string
      binAttributes:
        $ref: '#/definitions/Dictionary_String_Boolean'
        description: >-
          Available binAttributes of card. <a
          href='https://triposcert.vantiv.com/api/help/kb/cardBinAttributes.html'>more&raquo;</a>
      binValue:
        description: The BIN entry that matched the account number.
        type: string
      cardLogo:
        description: 'The card logo (e.g. Visa, Mastercard, etc).'
        type: string
      entryMode:
        description: 'Description of how card was entered: Keyed, Swiped, Chip.'
        type: string
      giftPointsBalance:
        description: >-
          This field provides gift points balance for Valutec gift/loyalty
          cards.
        type: string
      giftRewardLevel:
        description: This field provides gift reward level for Valutec gift/loyalty cards.
        type: string
      isApproved:
        description: Set to true if the host approved the transaction.
        type: boolean
      isOffline:
        description: >-
          A boolean value indicating whether triPOS is disconnected from the
          host.
        type: boolean
      merchantId:
        description: The Merchant used to process the transaction.
        type: string
      statusCode:
        description: The status code for the transaction.
        type: string
      terminalId:
        description: The ID of the terminal used during the transaction
        type: string
      totalAmount:
        description: The total amount of the transaction.
        format: double
        type: number
      transactionDateTime:
        description: Transaction date/time in ISO8601 format
        type: string
      transactionId:
        description: The transaction ID from the processor
        type: string
  BarcodeRequest:
    description: BarcodeRequest
  BarcodeResponse:
    description: BarcodeResponse
    properties:
      _errors:
        description: A list of errors that occurred.
        items:
          $ref: '#/definitions/ApiError'
        type: array
      _hasErrors:
        description: Indicates if there are errors.
        type: boolean
      _links:
        description: A list of resource links
        items:
          $ref: '#/definitions/ApiLink'
        type: array
      _logs:
        description: >-
          A list of log entries detailing what happened during the request.
          Ideally only used during development or troubleshooting as this can be
          quite verbose.
        items:
          type: string
        type: array
      _type:
        description: The type of object held in the result.
        type: string
      _warnings:
        description: A list of warnings that occurred.
        items:
          $ref: '#/definitions/ApiWarning'
        type: array
      laneId:
        description: The lane ID.
        format: int32
        type: integer
      readData:
        description: The data read by a barcode scan in Base64.
        type: string
      result:
        description: The result of the barcode scan.
        type: string
      symbology:
        $ref: '#/definitions/BarcodeSymbology'
        description: The symbology of the barcode read.
  BarcodeSymbology:
    description: BarcodeSymbology
    properties:
      code:
        format: int32
        type: integer
      name:
        type: string
    required:
      - code
      - name
  BinQueryRequest:
    description: BinQueryRequest
    properties:
      invokeManualEntry:
        description: The flag that invokes manual entry directly.
        type: boolean
  BinQueryResponse:
    description: BinQueryResponse
    properties:
      _errors:
        description: A list of errors that occurred.
        items:
          $ref: '#/definitions/ApiError'
        type: array
      _hasErrors:
        description: Indicates if there are errors.
        type: boolean
      _links:
        description: A list of resource links
        items:
          $ref: '#/definitions/ApiLink'
        type: array
      _logs:
        description: >-
          A list of log entries detailing what happened during the request.
          Ideally only used during development or troubleshooting as this can be
          quite verbose.
        items:
          type: string
        type: array
      _processor:
        $ref: '#/definitions/Processor'
        description: Response information from the processor.
      _type:
        description: The type of object held in the result.
        type: string
      _warnings:
        description: A list of warnings that occurred.
        items:
          $ref: '#/definitions/ApiWarning'
        type: array
      check:
        description: Check card indicator
        type: boolean
      commercial:
        description: Commercial card indicator
        type: boolean
      credit:
        description: Credit card indicator
        type: boolean
      debit:
        description: Debit card indicator
        type: boolean
      durbinBinRegulation:
        description: Durbin BIN Regulation indicator
        type: string
      ebt:
        description: EBT card indicator
        type: boolean
      fleet:
        description: Fleet card indicator
        type: boolean
      gift:
        description: Gift card indicator
        type: boolean
      hsaFsa:
        description: HSA/FSA card indicator
        type: boolean
      internationalBin:
        description: International BIN indicator
        type: boolean
      pinlessBillPay:
        description: PINless Bill Pay indicator
        type: boolean
      prepaid:
        description: Prepaid card indicator
        type: boolean
      wic:
        description: WIC card indicator
        type: boolean
  CancelTransactionRequest:
    description: CancelTransactionRequest
    properties:
      laneId:
        description: The desired lane ID.
        format: int32
        type: integer
    required:
      - laneId
  CancelTransactionResponse:
    description: CancelTransactionResponse
    properties:
      _errors:
        description: A list of errors that occurred.
        items:
          $ref: '#/definitions/ApiError'
        type: array
      _hasErrors:
        description: Indicates if there are errors.
        type: boolean
      _links:
        description: A list of resource links
        items:
          $ref: '#/definitions/ApiLink'
        type: array
      _logs:
        description: >-
          A list of log entries detailing what happened during the request.
          Ideally only used during development or troubleshooting as this can be
          quite verbose.
        items:
          type: string
        type: array
      _type:
        description: The type of object held in the result.
        type: string
      _warnings:
        description: A list of warnings that occurred.
        items:
          $ref: '#/definitions/ApiWarning'
        type: array
  CardDiscoveryRequest:
    description: CardDiscoveryRequest
    properties:
      laneId:
        description: Specifies which lane to use.
        format: int32
        type: integer
    required:
      - laneId
  CardRequest:
    description: CardRequest
    properties:
      invokeManualEntry:
        description: The flag that invokes manual entry directly.
        type: boolean
  CardResponse:
    description: CardResponse
    properties:
      _errors:
        description: A list of errors that occurred.
        items:
          $ref: '#/definitions/ApiError'
        type: array
      _hasErrors:
        description: Indicates if there are errors.
        type: boolean
      _links:
        description: A list of resource links
        items:
          $ref: '#/definitions/ApiLink'
        type: array
      _logs:
        description: >-
          A list of log entries detailing what happened during the request.
          Ideally only used during development or troubleshooting as this can be
          quite verbose.
        items:
          type: string
        type: array
      _type:
        description: The type of object held in the result.
        type: string
      _warnings:
        description: A list of warnings that occurred.
        items:
          $ref: '#/definitions/ApiWarning'
        type: array
      binAttributes:
        $ref: '#/definitions/Dictionary_String_Boolean'
        description: >-
          Available binAttributes of card. <a
          href='https://triposcert.vantiv.com/api/help/kb/cardBinAttributes.html'>more&raquo;</a>
      cardType:
        description: >-
          Indidcates whether the card read was a financial or non-financial
          card.
        type: string
      financialCard:
        $ref: '#/definitions/FinancialCard'
        description: >-
          Fields for a financial card response. These fields are populated if
          the card read was a financial card.
      nonFinancialCard:
        $ref: '#/definitions/NonFinancialCard'
        description: >-
          Fields for a non-financial card response. These fields are populated
          if the card read was a non-financial card.
  CashbackManualEntry:
    description: CashbackManualEntry
    properties:
      amountIncrement:
        description: >-
          The PIN pad will only accept a cashback amount in the provided
          increment (i.e. Set to 5 to only allow cashback amounts in increments
          of $5.00).
        format: int32
        type: integer
      maximumAmount:
        description: >-
          The PIN pad will only accept a cashback amount that does not exceed
          the provided maximum.
        format: int32
        type: integer
  CashbackOptions:
    description: CashbackOptions
    properties:
      manualEntry:
        $ref: '#/definitions/POST_CashbackManualEntry_v1_sale'
        description: >-
          Configurable settings for allowing a cashback choice through manual
          entry.
      selectionAmounts:
        description: >-
          The cashback amounts to display on the PIN pad's selection buttons
          (i.e. 5,10,20,50).
        type: string
  CloseGiftRequest:
    description: CloseGiftRequest
    properties:
      cardHolderPresentCode:
        description: >-
          Defines whether the cardholder is present at the transaction. This
          value is optional, but recommended to be set. If this value is not set
          in the request, it will be automatically set based on the market code.
        type: string
      clerkNumber:
        description: An optional clerk number for reference.
        type: string
      configuration:
        $ref: '#/definitions/POST_RequestConfiguration_v1_gift_close'
        description: >-
          Any value included in this section will override the corresponding
          value set in the triPOS.config
      giftCardProgram:
        description: >-
          This field is for Valutec gift/loyalty card program. <br>'01' =
          Original Gift Card Program <br>'02' = Promotional Gift Card Program
          <br>'03' = Original Combo Card Program <br>'04' = Auto Rewards LPR
          Card Program <br>'05' = Original Loyalty Card Program
        type: string
      giftProgramType:
        description: >-
          This field is for Valutec gift/loyalty card type. The value 0 is for
          gift and 1 for loyalty
        type: string
      invokeManualEntry:
        description: ' Invokes manual card entry.'
        type: boolean
      isCscSupported:
        description: >-
          Invokes prompt for cardholder to enter card security code for manual
          keyed card entry.
        type: string
      laneId:
        description: Specifies which lane to use.
        format: int32
        type: integer
      referenceNumber:
        description: A user defined reference number.
        type: string
      shiftId:
        description: An optional shift id for reference.
        type: string
      storeCard:
        $ref: '#/definitions/POST_StoreCard_v1_gift_close'
        description: Information necessary to process a StoreCard transaction.
      ticketNumber:
        description: An optional ticket number.
        type: string
      transactionAmount:
        description: >-
          The total transaction amount. This is the amount of funds to move on
          the card
        format: double
        type: number
    required:
      - laneId
      - transactionAmount
  CloseGiftResponse:
    description: CloseGiftResponse
    properties:
      _errors:
        description: A list of errors that occurred.
        items:
          $ref: '#/definitions/ApiError'
        type: array
      _hasErrors:
        description: Indicates if there are errors.
        type: boolean
      _links:
        description: A list of resource links
        items:
          $ref: '#/definitions/ApiLink'
        type: array
      _logs:
        description: >-
          A list of log entries detailing what happened during the request.
          Ideally only used during development or troubleshooting as this can be
          quite verbose.
        items:
          type: string
        type: array
      _processor:
        $ref: '#/definitions/Processor'
        description: Response information from the processor.
      _type:
        description: The type of object held in the result.
        type: string
      _warnings:
        description: A list of warnings that occurred.
        items:
          $ref: '#/definitions/ApiWarning'
        type: array
      accountNumber:
        description: The card account number.
        type: string
      approvalNumber:
        description: >-
          Approval number from the processor. Depending on card type and
          processor an approval number might not be returned.
        type: string
      approvedAmount:
        description: The amount approved for the transaction.
        format: double
        type: number
      balanceAmount:
        description: The balance of the gift card.
        format: double
        type: number
      balanceCurrencyCode:
        description: The balance currency code.
        type: string
      binAttributes:
        $ref: '#/definitions/Dictionary_String_Boolean'
        description: >-
          Available binAttributes of card. <a
          href='https://triposcert.vantiv.com/api/help/kb/cardBinAttributes.html'>more&raquo;</a>
      binValue:
        description: The BIN entry that matched the account number.
        type: string
      cardLogo:
        description: 'The card logo (e.g. Visa, Mastercard, etc).'
        type: string
      entryMode:
        description: 'Description of how card was entered: Keyed, Swiped, Chip.'
        type: string
      giftPointsBalance:
        description: >-
          This field provides gift points balance for Valutec gift/loyalty
          cards.
        type: string
      giftRewardLevel:
        description: This field provides gift reward level for Valutec gift/loyalty cards.
        type: string
      isApproved:
        description: Set to true if the host approved the transaction.
        type: boolean
      isOffline:
        description: >-
          A boolean value indicating whether triPOS is disconnected from the
          host.
        type: boolean
      merchantId:
        description: The Merchant used to process the transaction.
        type: string
      statusCode:
        description: The status code for the transaction.
        type: string
      terminalId:
        description: The ID of the terminal used during the transaction
        type: string
      totalAmount:
        description: The total amount of the transaction.
        format: double
        type: number
      transactionDateTime:
        description: Transaction date/time in ISO8601 format
        type: string
      transactionId:
        description: The transaction ID from the processor
        type: string
  CreateOmniTokenRequest:
    description: CreateOmniTokenRequest
    properties:
      configuration:
        $ref: '#/definitions/POST_TokenRequestConfiguration_v1_token_omni'
        description: >-
          Any value included in this section will override the corresponding
          value set in the triPOS.config
      invokeManualEntry:
        description: Invokes manual card entry.
        type: boolean
      isCscSupported:
        description: >-
          Invokes prompt for cardholder to enter card security code for manual
          keyed card entry.
        type: string
      laneId:
        description: Specifies which lane to use.
        format: int32
        type: integer
      vaultId:
        description: The Vault ID with Omni.
        type: string
    required:
      - laneId
  CreateOmniTokenResponse:
    description: CreateOmniTokenResponse
    properties:
      _errors:
        description: A list of errors that occurred.
        items:
          $ref: '#/definitions/ApiError'
        type: array
      _hasErrors:
        description: Indicates if there are errors.
        type: boolean
      _links:
        description: A list of resource links
        items:
          $ref: '#/definitions/ApiLink'
        type: array
      _logs:
        description: >-
          A list of log entries detailing what happened during the request.
          Ideally only used during development or troubleshooting as this can be
          quite verbose.
        items:
          type: string
        type: array
      _processor:
        $ref: '#/definitions/Processor'
        description: Response information from the processor.
      _type:
        description: The type of object held in the result.
        type: string
      _warnings:
        description: A list of warnings that occurred.
        items:
          $ref: '#/definitions/ApiWarning'
        type: array
      accountNumber:
        description: The card account number.
        type: string
      binAttributes:
        $ref: '#/definitions/Dictionary_String_Boolean'
        description: >-
          Available binAttributes of card. <a
          href='https://triposcert.vantiv.com/api/help/kb/cardBinAttributes.html'>more&raquo;</a>
      binValue:
        description: >-
          The card bin value. This value is only provided for a
          CreateOmniTokenRequest NOT for a CreateOmniTokenWithTransIdRequest.
        type: string
      cardHolderName:
        description: >-
          The card holder name on the card. This value is only provided for a
          CreateOmniTokenRequest NOT for a CreateOmniTokenWithTransIdRequest. If
          the card is keyed for a CreateOmniTokenRequest this value will be
          empty.
        type: string
      cardLogo:
        description: >-
          The card logo. Possible values are: Visa, Mastercard, Discover, Amex,
          Diners Club, JCB, Carte Blanche, Other.
        type: string
      entryMode:
        description: >-
          Description of how card was entered. This value is only provided for a
          CreateOmniTokenRequest NOT for a CreateOmniTokenWithTransIdRequest.
        type: string
      expirationMonth:
        description: The card's expiration month
        type: string
      expirationYear:
        description: The card's expiration year
        type: string
      isOffline:
        description: >-
          A boolean value indicating whether triPOS is disconnected from the
          host.
        type: boolean
      merchantId:
        description: The merchant ID used to process the transaction.
        type: string
      tokenId:
        description: The Token ID.
        type: string
      tokenProvider:
        description: The Token Provider.
        type: string
      transactionDateTime:
        description: Transaction date/time in ISO8601 format
        type: string
  CreateOmniTokenWithTransIdRequest:
    description: CreateOmniTokenWithTransIdRequest
    properties:
      laneId:
        description: The lane ID.
        format: int32
        type: integer
      vaultId:
        description: The Vault ID with Omni.
        type: string
    required:
      - laneId
  CreatePaymentAccountCreditRequest:
    description: CreatePaymentAccountCreditRequest
    properties:
      address:
        $ref: '#/definitions/POST_Address_v1_paymentAccount_credit'
        description: The cardholder address information for the transaction.
      configuration:
        $ref: '#/definitions/POST_TokenRequestConfiguration_v1_paymentAccount_credit'
        description: >-
          Any value included in this section will override the corresponding
          value set in the triPOS.config
      expirationMonth:
        description: The expiration month.
        type: string
      expirationYear:
        description: The expiration year.
        type: string
      invokeManualEntry:
        description: ' Invokes manual card entry.'
        type: boolean
      isCscSupported:
        description: >-
          Invokes prompt for cardholder to enter card security code for manual
          keyed card entry.
        type: string
      laneId:
        description: The lane ID.
        format: int32
        type: integer
      paymentAccountReferenceNumber:
        description: The payment account reference number
        type: string
    required:
      - laneId
      - paymentAccountReferenceNumber
  CreatePaymentAccountCreditResponse:
    description: CreatePaymentAccountCreditResponse
    properties:
      _errors:
        description: A list of errors that occurred.
        items:
          $ref: '#/definitions/ApiError'
        type: array
      _hasErrors:
        description: Indicates if there are errors.
        type: boolean
      _links:
        description: A list of resource links
        items:
          $ref: '#/definitions/ApiLink'
        type: array
      _logs:
        description: >-
          A list of log entries detailing what happened during the request.
          Ideally only used during development or troubleshooting as this can be
          quite verbose.
        items:
          type: string
        type: array
      _processor:
        $ref: '#/definitions/Processor'
        description: Response information from the processor.
      _type:
        description: The type of object held in the result.
        type: string
      _warnings:
        description: A list of warnings that occurred.
        items:
          $ref: '#/definitions/ApiWarning'
        type: array
      accountNumber:
        description: The credit card number with the value masked except for the last 4.
        type: string
      approvalNumber:
        description: >-
          Approval number from the processor. Depending on card type and
          processor an approval number might not be returned.
        type: string
      binAttributes:
        $ref: '#/definitions/Dictionary_String_Boolean'
        description: >-
          Available binAttributes of card. <a
          href='https://triposcert.vantiv.com/api/help/kb/cardBinAttributes.html'>more&raquo;</a>
      binValue:
        description: The BIN entry that matched the account number.
        type: string
      cardHolderName:
        description: The cardholder name.
        type: string
      cardLogo:
        description: >-
          The card logo. Possible values are: Visa, Mastercard, Discover, Amex,
          Diners Club, JCB, Carte Blanche, Other.
        type: string
      entryMode:
        description: Description of how card was entered.
        type: string
      expirationMonth:
        description: The card's expiration month
        type: string
      expirationYear:
        description: The card's expiration year
        type: string
      fsaCard:
        description: >-
          Indicates whether the card used was a FSA card.<br />Note: Maybe = No
          BIN entry to determine if FSA.
        type: string
      isApproved:
        description: Set to true if the host approved the transaction.
        type: boolean
      isOffline:
        description: >-
          A boolean value indicating whether triPOS is disconnected from the
          host.
        type: boolean
      merchantId:
        description: The Merchant used to process the transaction.
        type: string
      paymentAccountId:
        description: the payment account ID.
        type: string
      paymentAccountReferenceNumber:
        description: the payment account reference number.
        type: string
      statusCode:
        description: The status code for the transaction.
        type: string
      terminalId:
        description: The ID of the terminal used during the transaction.
        type: string
      transactionDateTime:
        description: Transaction date/time in ISO8601 format
        type: string
      transactionId:
        description: The transaction ID from the processor
        type: string
  CreatePaymetricTokenRequest:
    description: CreatePaymetricTokenRequest
    properties:
      configuration:
        $ref: '#/definitions/POST_TokenRequestConfiguration_v1_token_paymetric'
        description: >-
          Any value included in this section will override the corresponding
          value set in the triPOS.config
      invokeManualEntry:
        description: ' Invokes manual card entry.'
        type: boolean
      isCscSupported:
        description: >-
          Invokes prompt for cardholder to enter card security code for manual
          keyed card entry.
        type: string
      laneId:
        description: Specifies which lane to use.
        format: int32
        type: integer
      vaultId:
        description: The Vault ID with Paymetric.
        type: string
    required:
      - laneId
      - vaultId
  CreatePaymetricTokenResponse:
    description: CreatePaymetricTokenResponse
    properties:
      _errors:
        description: A list of errors that occurred.
        items:
          $ref: '#/definitions/ApiError'
        type: array
      _hasErrors:
        description: Indicates if there are errors.
        type: boolean
      _links:
        description: A list of resource links
        items:
          $ref: '#/definitions/ApiLink'
        type: array
      _logs:
        description: >-
          A list of log entries detailing what happened during the request.
          Ideally only used during development or troubleshooting as this can be
          quite verbose.
        items:
          type: string
        type: array
      _processor:
        $ref: '#/definitions/Processor'
        description: Response information from the processor.
      _type:
        description: The type of object held in the result.
        type: string
      _warnings:
        description: A list of warnings that occurred.
        items:
          $ref: '#/definitions/ApiWarning'
        type: array
      accountNumber:
        description: The card account number.
        type: string
      binAttributes:
        $ref: '#/definitions/Dictionary_String_Boolean'
        description: >-
          Available binAttributes of card. <a
          href='https://triposcert.vantiv.com/api/help/kb/cardBinAttributes.html'>more&raquo;</a>
      binValue:
        description: >-
          The card bin value. This value is only provided for a
          CreatePaymetricTokenRequest NOT for a
          CreatePaymetricTokenWithTransIdRequest.
        type: string
      cardHolderName:
        description: >-
          The card holder name on the card. This value is only provided for a
          CreatePaymetricTokenRequest NOT for a
          CreatePaymetricTokenWithTransIdRequest. If the card is keyed for a
          CreatePaymetricTokenRequest this value will be empty.
        type: string
      cardLogo:
        description: >-
          The card logo. Possible values are: Visa, Mastercard, Discover, Amex,
          Diners Club, JCB, Carte Blanche, Other.
        type: string
      entryMode:
        description: >-
          Description of how card was entered. This value is only provided for a
          CreatePaymetricTokenRequest NOT for a
          CreatePaymetricTokenWithTransIdRequest.
        type: string
      expirationMonth:
        description: The card's expiration month
        type: string
      expirationYear:
        description: The card's expiration year
        type: string
      isOffline:
        description: >-
          A boolean value indicating whether triPOS is disconnected from the
          host.
        type: boolean
      merchantId:
        description: The merchant ID used to process the transaction.
        type: string
      tokenId:
        description: The Token ID.
        type: string
      tokenProvider:
        description: The Token Provider.
        type: string
      transactionDateTime:
        description: Transaction date/time in ISO8601 format
        type: string
  CreatePaymetricTokenWithTransIdRequest:
    description: CreatePaymetricTokenWithTransIdRequest
    properties:
      laneId:
        description: The lane ID.
        format: int32
        type: integer
      vaultId:
        description: The Vault ID with Paymetric.
        type: string
    required:
      - laneId
      - vaultId
  CreateWorldpayTokenRequest:
    description: CreateWorldpayTokenRequest
    properties:
      configuration:
        $ref: '#/definitions/POST_TokenRequestConfiguration_v1_token_worldpay'
        description: >-
          Any value included in this section will override the corresponding
          value set in the triPOS.config
      invokeManualEntry:
        description: Invokes manual card entry.
        type: boolean
      laneId:
        description: Specifies which lane to use.
        format: int32
        type: integer
      schemeReference:
        description: schemeReference of token to be created
        type: string
      type:
        description: >-
          Type of token to be created. Eg: cardOnFile, unscheduled,
          subscription, installment
        type: string
      usage:
        description: 'Usage of token to be created. Eg: first, subsequent, resubmission'
        type: string
    required:
      - laneId
      - type
      - usage
  CreateWorldpayTokenResponse:
    description: CreateWorldpayTokenResponse
    properties:
      _errors:
        description: A list of errors that occurred.
        items:
          $ref: '#/definitions/ApiError'
        type: array
      _hasErrors:
        description: Indicates if there are errors.
        type: boolean
      _links:
        description: A list of resource links
        items:
          $ref: '#/definitions/ApiLink'
        type: array
      _logs:
        description: >-
          A list of log entries detailing what happened during the request.
          Ideally only used during development or troubleshooting as this can be
          quite verbose.
        items:
          type: string
        type: array
      _processor:
        $ref: '#/definitions/Processor'
        description: Response information from the processor.
      _type:
        description: The type of object held in the result.
        type: string
      _warnings:
        description: A list of warnings that occurred.
        items:
          $ref: '#/definitions/ApiWarning'
        type: array
      accountNumber:
        description: The card account number.
        type: string
      binAttributes:
        $ref: '#/definitions/Dictionary_String_Boolean'
        description: >-
          Available binAttributes of card. <a
          href='https://triposcert.vantiv.com/api/help/kb/cardBinAttributes.html'>more&raquo;</a>
      cardHolderName:
        description: >-
          The card holder name on the card. This value is only provided for a
          CreateOmniTokenRequest NOT for a CreateOmniTokenWithTransIdRequest. If
          the card is keyed for a CreateOmniTokenRequest this value will be
          empty.
        type: string
      cardLogo:
        description: >-
          The card logo. Possible values are: Visa, Mastercard, Discover, Amex,
          Diners Club, JCB, Carte Blanche, Other.
        type: string
      entryMode:
        description: >-
          Description of how card was entered. This value is only provided for a
          CreateOmniTokenRequest NOT for a CreateOmniTokenWithTransIdRequest.
        type: string
      expirationMonth:
        description: The card's expiration month
        type: string
      expirationYear:
        description: The card's expiration year
        type: string
      isOffline:
        description: >-
          A boolean value indicating whether triPOS is disconnected from the
          host.
        type: boolean
      merchantId:
        description: The merchant ID used to process the transaction.
        type: string
      tokenId:
        description: The Token ID.
        type: string
      tokenProvider:
        description: The Token Provider.
        type: string
      transactionDateTime:
        description: Transaction date/time in ISO8601 format
        type: string
  CreditCardForceResponse:
    description: CreditCardForceResponse
    properties:
      _errors:
        description: A list of errors that occurred.
        items:
          $ref: '#/definitions/ApiError'
        type: array
      _hasErrors:
        description: Indicates if there are errors.
        type: boolean
      _links:
        description: A list of resource links
        items:
          $ref: '#/definitions/ApiLink'
        type: array
      _logs:
        description: >-
          A list of log entries detailing what happened during the request.
          Ideally only used during development or troubleshooting as this can be
          quite verbose.
        items:
          type: string
        type: array
      _processor:
        $ref: '#/definitions/Processor'
        description: Response information from the processor.
      _type:
        description: The type of object held in the result.
        type: string
      _warnings:
        description: A list of warnings that occurred.
        items:
          $ref: '#/definitions/ApiWarning'
        type: array
      accountNumber:
        description: The card account number.
        type: string
      accountType:
        description: The account type selected and used in the transaction.
        type: string
      approvalNumber:
        description: >-
          Approval number from the processor. Depending on card type and
          processor an approval number might not be returned.
        type: string
      balanceAmount:
        description: The balance of the gift card.
        format: double
        type: number
      balanceCurrencyCode:
        description: The balance currency code.
        type: string
      binAttributes:
        $ref: '#/definitions/Dictionary_String_Boolean'
        description: >-
          Available binAttributes of card. <a
          href='https://triposcert.vantiv.com/api/help/kb/cardBinAttributes.html'>more&raquo;</a>
      binValue:
        description: The BIN entry that matched the account number.
        type: string
      cardHolderName:
        description: The cardholder name.
        type: string
      cardLogo:
        description: >-
          The card logo. Possible values are: Visa, Mastercard, Discover, Amex,
          Diners Club, JCB, Carte Blanche, Other.
        type: string
      conversionRate:
        description: Conversion rate for the ForeignCurrencyCode.
        type: string
      countryCode:
        description: The country code used in the transaction.
        type: string
      currencyCode:
        description: The currency code used in the transaction.
        type: string
      driverID:
        description: Fleet DriverID Input On The Device
        type: string
      ebtType:
        description: The type of the EBT card
        type: string
      entryMode:
        description: Description of how card was entered.
        type: string
      expirationMonth:
        description: The card's expiration month
        type: string
      expirationYear:
        description: The card's expiration year
        type: string
      fleetAdditionalPromptedData1:
        description: Fleet Additional Prompted Data1 Input On The Device
        type: string
      fleetAdditionalPromptedData2:
        description: Fleet Additional Prompted Data2 Input On The Device
        type: string
      fleetEmployeeNumber:
        description: Fleet Employee Number Input On The Device
        type: string
      fleetJobNumber:
        description: Fleet Job Number Input On The Device
        type: string
      fleetTrailerNumber:
        description: Fleet Trailer Number Input On The Device
        type: string
      fleetUserID:
        description: Fleet UserID Input On The Device
        type: string
      foreignCurrencyCode:
        description: Currency code of the foreign currency.
        type: string
      foreignTransactionAmount:
        description: Transaction amount shown in the foreign currency.
        type: string
      isApproved:
        description: Set to true if the host approved the transaction.
        type: boolean
      isFleetOdometerPrint:
        description: is Fleet Odometer value Print On the Receipt or not
        type: boolean
      isOffline:
        description: >-
          A boolean value indicating whether triPOS is disconnected from the
          host.
        type: boolean
      language:
        description: The language used in the transaction.
        type: string
      merchantId:
        description: The Merchant used to process the transaction.
        type: string
      networkLabel:
        description: >-
          Label that shows the network where the transaction was routed for
          authorization
        type: string
      odometer:
        description: Fleet Odometer Input On The Device
        type: string
      paymentType:
        description: Description of payment type utilized.
        type: string
      pinVerified:
        description: 'True if the PIN was verified, false if not verified or undetermined.'
        type: boolean
      preReadId:
        $ref: '#/definitions/Guid'
        description: >-
          Unique ID. If checkForPreReadId field is true, then this ID will be
          required for the Quick Chip portion of the transaction to be
          successful.
      purchaseDeviceSequenceNumber:
        description: Fleet Purchase Device Sequence Number from the card
        type: string
      quickChipMessage:
        description: The message unique to QuickChip pre-read functionality only.
        type: string
      signature:
        $ref: '#/definitions/Signature'
        description: The signature data.
      statusCode:
        description: The status code for the transaction.
        type: string
      terminalId:
        description: The ID of the terminal used during the transaction
        type: string
      totalAmount:
        description: The total amount of the transaction.
        format: double
        type: number
      transactionDateTime:
        description: Transaction date/time in ISO8601 format
        type: string
      transactionId:
        description: The transaction ID from the processor
        type: string
      vehicleID:
        description: Fleet Vehicle ID Input On The Device
        type: string
  DELETE_DeletePaymentAccountRequest_v1_paymentAccount_paymentAccountId:
    description: DeletePaymentAccountRequest
    properties:
      cardHolderPresentCode:
        description: >-
          Defines whether the cardholder is present at the transaction. This
          value is optional, but recommended to be set. If this value is not set
          in the request, it will be automatically set based on the market code.
        type: string
      clerkNumber:
        description: An optional clerk number for reference.
        type: string
      laneId:
        description: Specifies which lane to use.
        format: int32
        type: integer
      referenceNumber:
        description: A user defined reference number.
        type: string
      shiftId:
        description: An optional shift id for reference.
        type: string
      ticketNumber:
        description: An optional ticket number.
        type: string
  DeletePaymentAccountRequest:
    description: DeletePaymentAccountRequest
    properties:
      cardHolderPresentCode:
        description: >-
          Defines whether the cardholder is present at the transaction. This
          value is optional, but recommended to be set. If this value is not set
          in the request, it will be automatically set based on the market code.
        type: string
      clerkNumber:
        description: An optional clerk number for reference.
        type: string
      laneId:
        description: Specifies which lane to use.
        format: int32
        type: integer
      referenceNumber:
        description: A user defined reference number.
        type: string
      shiftId:
        description: An optional shift id for reference.
        type: string
      ticketNumber:
        description: An optional ticket number.
        type: string
  DeletePaymentAccountResponse:
    description: DeletePaymentAccountResponse
    properties:
      _errors:
        description: A list of errors that occurred.
        items:
          $ref: '#/definitions/ApiError'
        type: array
      _hasErrors:
        description: Indicates if there are errors.
        type: boolean
      _links:
        description: A list of resource links
        items:
          $ref: '#/definitions/ApiLink'
        type: array
      _logs:
        description: >-
          A list of log entries detailing what happened during the request.
          Ideally only used during development or troubleshooting as this can be
          quite verbose.
        items:
          type: string
        type: array
      _processor:
        $ref: '#/definitions/Processor'
        description: Response information from the processor.
      _type:
        description: The type of object held in the result.
        type: string
      _warnings:
        description: A list of warnings that occurred.
        items:
          $ref: '#/definitions/ApiWarning'
        type: array
      merchantId:
        description: The merchant ID.
        type: string
      paymentAccountId:
        description: The payment account ID that was deleted.
        type: string
      terminalId:
        description: The ID of the terminal used during the transaction
        type: string
      transactionDateTime:
        description: Transaction date/time in ISO8601 format
        type: string
  'Dictionary[String,Boolean]':
    description: 'Dictionary[String,Boolean]'
    properties:
      comparer:
        $ref: '#/definitions/IEqualityComparer_String'
      count:
        format: int32
        type: integer
      item:
        type: boolean
      keys:
        $ref: '#/definitions/Dictionary_String_Boolean'
      values:
        $ref: '#/definitions/Dictionary_String_Boolean'
    required:
      - comparer
      - count
      - item
      - keys
      - values
  Dictionary_String_Boolean:
    description: 'Dictionary[String,Boolean]'
    properties:
      comparer:
        $ref: '#/definitions/IEqualityComparer_String'
      count:
        format: int32
        type: integer
      item:
        type: boolean
      keys:
        $ref: '#/definitions/Dictionary_String_Boolean'
      values:
        $ref: '#/definitions/Dictionary_String_Boolean'
    required:
      - comparer
      - count
      - item
      - keys
      - values
  DisplayRequest:
    description: DisplayRequest
    properties:
      laneId:
        description: The lane ID.
        format: int32
        type: integer
      text:
        description: >-
          The full text to display on the PIN pad. triPOS may split the text
          into multiple lines based on the size of the PIN pad's screen. Please
          test the text with the desired PIN pad to make sure it is displayed as
          expected. <a href='https://triposcert.vantiv.com/api/help/kb/display.html'>more&raquo;</a>
        type: string
    required:
      - laneId
  DisplayResponse:
    description: DisplayResponse
    properties:
      _errors:
        description: A list of errors that occurred.
        items:
          $ref: '#/definitions/ApiError'
        type: array
      _hasErrors:
        description: Indicates if there are errors.
        type: boolean
      _links:
        description: A list of resource links
        items:
          $ref: '#/definitions/ApiLink'
        type: array
      _logs:
        description: >-
          A list of log entries detailing what happened during the request.
          Ideally only used during development or troubleshooting as this can be
          quite verbose.
        items:
          type: string
        type: array
      _type:
        description: The type of object held in the result.
        type: string
      _warnings:
        description: A list of warnings that occurred.
        items:
          $ref: '#/definitions/ApiWarning'
        type: array
  EbtVoucherRequest:
    description: EbtVoucherRequest
    properties:
      approvalNumber:
        description: The approval number of a voice authorization
        type: string
      cardHolderPresentCode:
        description: >-
          Defines whether the cardholder is present at the transaction. This
          value is optional, but recommended to be set. If this value is not set
          in the request, it will be automatically set based on the market code.
        type: string
      clerkNumber:
        description: An optional clerk number for reference.
        type: string
      configuration:
        $ref: '#/definitions/POST_EbtVoucherRequestConfiguration_v1_ebtVoucher'
        description: >-
          Any value included in this section will override the corresponding
          value set in the triPOS.config
      isCscSupported:
        description: >-
          Invokes prompt for cardholder to enter card security code for manual
          keyed card entry.
        type: string
      laneId:
        description: Specifies which lane to use.
        format: int32
        type: integer
      referenceNumber:
        description: A user defined reference number.
        type: string
      ticketNumber:
        description: An optional ticket number.
        type: string
      transactionAmount:
        description: >-
          The total transaction amount. This is the amount of funds to move on
          the card.
        format: double
        type: number
      voucherNumber:
        description: The voucher number to complete a foodstamp purchase.
        type: string
    required:
      - approvalNumber
      - laneId
      - transactionAmount
      - voucherNumber
  EbtVoucherRequestConfiguration:
    description: EbtVoucherRequestConfiguration
    properties:
      checkForDuplicateTransactions:
        description: >-
          If set to true, enables duplicate checking logic for the transaction
          at the host.
        type: boolean
      marketCode:
        description: 'The market code of the transaction. '
        type: string
  EbtVoucherResponse:
    description: EbtVoucherResponse
    properties:
      _errors:
        description: A list of errors that occurred.
        items:
          $ref: '#/definitions/ApiError'
        type: array
      _hasErrors:
        description: Indicates if there are errors.
        type: boolean
      _links:
        description: A list of resource links
        items:
          $ref: '#/definitions/ApiLink'
        type: array
      _logs:
        description: >-
          A list of log entries detailing what happened during the request.
          Ideally only used during development or troubleshooting as this can be
          quite verbose.
        items:
          type: string
        type: array
      _processor:
        $ref: '#/definitions/Processor'
        description: Response information from the processor.
      _type:
        description: The type of object held in the result.
        type: string
      _warnings:
        description: A list of warnings that occurred.
        items:
          $ref: '#/definitions/ApiWarning'
        type: array
      accountNumber:
        description: The card account number.
        type: string
      accountType:
        description: The account type selected and used in the transaction.
        type: string
      approvalNumber:
        description: >-
          Approval number from the processor. Depending on card type and
          processor an approval number might not be returned.
        type: string
      balanceAmount:
        description: The balance of the gift card.
        format: double
        type: number
      balanceCurrencyCode:
        description: The balance currency code.
        type: string
      binAttributes:
        $ref: '#/definitions/Dictionary_String_Boolean'
        description: >-
          Available binAttributes of card. <a
          href='https://triposcert.vantiv.com/api/help/kb/cardBinAttributes.html'>more&raquo;</a>
      binValue:
        description: The BIN entry that matched the account number.
        type: string
      cardHolderName:
        description: The cardholder name.
        type: string
      cardLogo:
        description: >-
          The card logo. Possible values are: Visa, Mastercard, Discover, Amex,
          Diners Club, JCB, Carte Blanche, Other.
        type: string
      conversionRate:
        description: Conversion rate for the ForeignCurrencyCode.
        type: string
      countryCode:
        description: The country code used in the transaction.
        type: string
      currencyCode:
        description: The currency code used in the transaction.
        type: string
      driverID:
        description: Fleet DriverID Input On The Device
        type: string
      ebtType:
        description: The type of the EBT card
        type: string
      entryMode:
        description: Description of how card was entered.
        type: string
      expirationMonth:
        description: The card's expiration month
        type: string
      expirationYear:
        description: The card's expiration year
        type: string
      fleetAdditionalPromptedData1:
        description: Fleet Additional Prompted Data1 Input On The Device
        type: string
      fleetAdditionalPromptedData2:
        description: Fleet Additional Prompted Data2 Input On The Device
        type: string
      fleetEmployeeNumber:
        description: Fleet Employee Number Input On The Device
        type: string
      fleetJobNumber:
        description: Fleet Job Number Input On The Device
        type: string
      fleetTrailerNumber:
        description: Fleet Trailer Number Input On The Device
        type: string
      fleetUserID:
        description: Fleet UserID Input On The Device
        type: string
      foreignCurrencyCode:
        description: Currency code of the foreign currency.
        type: string
      foreignTransactionAmount:
        description: Transaction amount shown in the foreign currency.
        type: string
      isApproved:
        description: Set to true if the host approved the transaction.
        type: boolean
      isFleetOdometerPrint:
        description: is Fleet Odometer value Print On the Receipt or not
        type: boolean
      isOffline:
        description: >-
          A boolean value indicating whether triPOS is disconnected from the
          host.
        type: boolean
      language:
        description: The language used in the transaction.
        type: string
      merchantId:
        description: The Merchant used to process the transaction.
        type: string
      networkLabel:
        description: >-
          Label that shows the network where the transaction was routed for
          authorization
        type: string
      odometer:
        description: Fleet Odometer Input On The Device
        type: string
      paymentType:
        description: Description of payment type utilized.
        type: string
      pinVerified:
        description: 'True if the PIN was verified, false if not verified or undetermined.'
        type: boolean
      preReadId:
        $ref: '#/definitions/Guid'
        description: >-
          Unique ID. If checkForPreReadId field is true, then this ID will be
          required for the Quick Chip portion of the transaction to be
          successful.
      purchaseDeviceSequenceNumber:
        description: Fleet Purchase Device Sequence Number from the card
        type: string
      signature:
        $ref: '#/definitions/Signature'
        description: The signature data.
      statusCode:
        description: The status code for the transaction.
        type: string
      terminalId:
        description: The ID of the terminal used during the transaction
        type: string
      totalAmount:
        description: The total amount of the transaction.
        format: double
        type: number
      transactionDateTime:
        description: Transaction date/time in ISO8601 format
        type: string
      transactionId:
        description: The transaction ID from the processor
        type: string
      vehicleID:
        description: Fleet Vehicle ID Input On The Device
        type: string
  Emv:
    description: Emv
    properties:
      tags:
        description: >-
          A name value collection of additional EMV tags that are required to
          appear on the receipt.
        items:
          $ref: '#/definitions/Tag'
        type: array
      applicationIdentifier:
        description: >-
          The Application Identifier also known as the AID. Identifies the
          application as described in ISO/IEC 7816-5. Printed receipts are
          required to contain the AID as hexadecimal characters.
        type: string
      applicationLabel:
        description: >-
          Mnemonic associated with the AID according to ISO/IEC 7816-5. If the
          Application Preferred Name is not available or the Issuer code table
          index is not supported, then the Application Label should be used on
          the receipt instead of the Application Preferred Name.
        type: string
      applicationPreferredName:
        description: >-
          Preferred mnemonic associated with the AID. When the Application
          Preferred Name is present and the Issuer code table index is
          supported, then this data element is mandatory on the receipt.
        type: string
      applicationTransactionCounter:
        description: The application transaction counter.
        type: string
      cryptogram:
        description: >-
          The EMV cryptogram type and value. It is a preferred best practice to
          include this data element on the receipt, but is not mandatory. This
          field contains cryptogram type followed by the cryptogram value.
        type: string
      issuerCodeTableIndex:
        description: >-
          Indicates the code table according to ISO/IEC 8859 for displaying the
          Application Preferred Name.
        type: string
      pinBypassed:
        type: boolean
  EmvTagKeyValue:
    description: EmvTagKeyValue
    properties:
      key:
        type: string
      value:
        type: string
  EncryptedCardData:
    description: EncryptedCardData
    properties:
      cardDataKeySerialNumber:
        description: Encrypted card data key serial number.
        type: string
      cardNumberMasked:
        description: The masked card number.
        type: string
      cvv:
        description: Card verification value found on the card.
        type: string
      encryptedFormat:
        description: The format of the encrypted manual keyed card data.
        type: string
      encryptedManualKeyedCardData:
        description: Encrypted manually keyed card data.
        type: string
      encryptedTrack1Data:
        description: Encrypted swiped track 1 data.
        type: string
      encryptedTrack2Data:
        description: Encrypted swiped track 2 data.
        type: string
      keySerialNumber:
        description: PIN key serial number.
        type: string
      magneprintData:
        description: Raw output of certain devices directly supported by Express.
        type: string
      pinBlock:
        description: Encrypted PIN block information sent from the PIN encryption device.
        type: string
      track1Data:
        description: Clear text swiped track 1 data.
        type: string
      track2Data:
        description: Clear text swiped track 2 data.
        type: string
      track3Data:
        description: Clear text swiped track 3 data.
        type: string
  FinancialCard:
    description: FinancialCard
    properties:
      accountNumber:
        description: The card account number.
        type: string
      binValue:
        description: The BIN entry that matched the account number.
        type: string
      cardEntryMode:
        description: Card entry mode
        type: string
      cardLogo:
        description: 'Brand of the card. Possible values include: Visa, Mastercard, Discover'
        type: string
      cardholderName:
        description: The name of the cardholder as printed on the front of the card
        type: string
      encryptedCardData:
        $ref: '#/definitions/EncryptedCardData'
        description: The encrypted card data
      expirationMonth:
        description: The card's expiration month
        type: string
      expirationYear:
        description: The card's expiration year
        type: string
  FinancialCardDiscoveryRequest:
    description: FinancialCardDiscoveryRequest
    properties:
      laneId:
        description: Specifies which lane to use.
        format: int32
        type: integer
    required:
      - laneId
  FinancialCardRequest:
    description: FinancialCardRequest
    properties:
      invokeManualEntry:
        description: The flag that invokes manual entry directly.
        type: boolean
  FinancialCardResponse:
    description: FinancialCardResponse
    properties:
      _errors:
        description: A list of errors that occurred.
        items:
          $ref: '#/definitions/ApiError'
        type: array
      _hasErrors:
        description: Indicates if there are errors.
        type: boolean
      _links:
        description: A list of resource links
        items:
          $ref: '#/definitions/ApiLink'
        type: array
      _logs:
        description: >-
          A list of log entries detailing what happened during the request.
          Ideally only used during development or troubleshooting as this can be
          quite verbose.
        items:
          type: string
        type: array
      _type:
        description: The type of object held in the result.
        type: string
      _warnings:
        description: A list of warnings that occurred.
        items:
          $ref: '#/definitions/ApiWarning'
        type: array
      accountNumber:
        description: The card account number.
        type: string
      binAttributes:
        $ref: '#/definitions/Dictionary_String_Boolean'
        description: >-
          Available binAttributes of card. <a
          href='https://triposcert.vantiv.com/api/help/kb/cardBinAttributes.html'>more&raquo;</a>
      binValue:
        description: The BIN entry that matched the account number.
        type: string
      cardEntryMode:
        description: Card entry mode
        type: string
      cardLogo:
        description: 'Brand of the card. Possible values include: Visa, Mastercard, Discover'
        type: string
      cardholderName:
        description: The name of the cardholder as printed on the front of the card
        type: string
      encryptedCardData:
        $ref: '#/definitions/EncryptedCardData'
        description: The encrypted card data
      expirationMonth:
        description: The card's expiration month
        type: string
      expirationYear:
        description: The card's expiration year
        type: string
  Fleet:
    description: Fleet
    properties:
      destinationCountryCode:
        description: Country code where goods are being shipped.
        type: string
      destinationZipCode:
        description: >-
          Postal/Zip Code of the address to where the purchased goods are being
          shipped. Recommend using merchant zip code for card-present.
        type: string
      discountAmount:
        description: >-
          Discount amount applied to the line item total.  This field should be
          0.00 if the unit cost reflects a discount price or if no line item
          discount applies.
        type: string
      lineItemCount:
        description: >-
          Number of line items included in transaction. Fleet supports 1 to 7
          line items.
        type: string
      lineItemDetail:
        $ref: >-
          #/definitions/POST_FleetLineItemDetail_v1_sale_transactionId_return_paymentType
        description: >-
          LineItemDetail includes the required Level III LineItem fields to be
          submitted.
      orderDate:
        description: Purchase order date.  YYYYMMDD
        type: string
      shipfromZipCode:
        description: >-
          Postal/Zip Code of the address to where the purchased goods are being
          shipped. Recommend using merchant zip code for card-present.
        type: string
      summaryCommodityCode:
        description: International description code of overall goods or services.
        type: string
    required:
      - destinationCountryCode
      - destinationZipCode
      - discountAmount
      - lineItemCount
      - lineItemDetail
      - orderDate
      - shipfromZipCode
      - summaryCommodityCode
  FleetLineItem:
    description: FleetLineItem
    properties:
      alternateTaxIdentifier:
        description: >-
          Tax identification number of the merchant reporting the alternate tax
          amount.  Not applicable for US merchants. (tag must be present, but
          can be empty)
        type: string
      debitCreditCode:
        description: >-
          Indicates whether extendedItemAmount is a Credit (taking away from the
          total amount of the sale) or Debit (adding to the total amount of the
          sale).  Recommend 0
        type: string
      discountCode:
        description: >-
          Indicates whether discount was applied to the purchase price of the
          item.  Recommend 0.
        type: string
      extendedItemAmount:
        description: >-
          Amount of the item (unit price multiplied by quantity only). 
          DDDDDDDDD.CC
        type: string
      itemCommodityCode:
        description: >-
          International description code of the individual good or service being
          supplied.  Recommend using numeric NACS code.
        type: string
      itemDescription:
        description: Item Description.
        type: string
      itemDiscountRate:
        description: >-
          Discount rate for the line item.  Submitted as a percentage. 
          Two-digit implied string.  Recommend 0.  For example, if 10.42%,
          submit 1042
        type: string
      lineItemDiscountAmount:
        description: >-
          Discount amount applied to the line item.  This field should be 0.00
          if the unit cost reflects a discount price or if no line item discount
          applies.  DDDDDDDDD.CC
        format: double
        type: number
      lineItemTotalAmount:
        description: >-
          Total full amount associated with the line item (UnitCost * Quantity)
          - LineItemDiscountAmount for that item. DDDDDDDDD.CC
        format: double
        type: number
      lineItemVatAmount:
        description: >-
          Amount of any sales or value added taxes associated with the item. 
          Recommend 0.00.  DDDDDDDDD.CC
        type: string
      lineItemVatRate:
        description: >-
          Tax rate used to calculate LineItemVATAmount.  Submitted as a
          percentage.  Two-digit implied string.  Recommend 0.  For example, if
          10.42%, submit 1042
        type: string
      netGrossCode:
        description: Indicates whether extended item amount included the tax.  Recommend 0.
        type: string
      productCode:
        description: Numeric NACS code.
        type: string
      quantity:
        description: Quantity of the item.  NNNNN.DDD
        format: double
        type: number
      unitCost:
        description: Unit cost of the item.  DDDDD.CC
        format: double
        type: number
      unitOfMeasure:
        description: Code for units of measurement.
        type: string
      vatType:
        description: >-
          Type of value added taxes being used. Not applicable for US merchants.
          (tag must be present, but can be empty)
        type: string
    required:
      - debitCreditCode
      - discountCode
      - extendedItemAmount
      - itemCommodityCode
      - itemDescription
      - itemDiscountRate
      - lineItemDiscountAmount
      - lineItemTotalAmount
      - lineItemVatAmount
      - lineItemVatRate
      - netGrossCode
      - productCode
      - quantity
      - unitCost
      - unitOfMeasure
  FleetLineItemDetail:
    description: FleetLineItemDetail
    properties:
      lineItem:
        description: lineItem that required Level III LineItem fields to be submitted.
        items:
          $ref: >-
            #/definitions/POST_FleetLineItem_v1_sale_transactionId_return_paymentType
        type: array
    required:
      - lineItem
  ForceCreditRequest:
    description: ForceCreditRequest
    properties:
      address:
        $ref: '#/definitions/POST_Address_v1_force_credit'
        description: The cardholder address information for the transaction.
      approvalNumber:
        description: The approval number of a voice authorization
        type: string
      autoRental:
        $ref: '#/definitions/POST_AutoRental_v1_force_credit'
        description: >-
          The auto rental parameters to be passed in for an auto rental
          transaction. <a href='https://triposcert.vantiv.com/api/help/kb/autorental.html'>more&raquo;</a>
      cardHolderPresentCode:
        description: >-
          Defines whether the cardholder is present at the transaction. This
          value is optional, but recommended to be set. If this value is not set
          in the request, it will be automatically set based on the market code.
        type: string
      checkForPreReadId:
        description: >-
          Flag to support 'PreReadId feature in quick chip' transaction request.
          This will take precedence over triPOS.config flag.
        type: boolean
      clerkNumber:
        description: An optional clerk number for reference.
        type: string
      commercialCardCustomerCode:
        description: >-
          The commercial card customer code for the transaction. This is for
          Level II.
        type: string
      configuration:
        $ref: '#/definitions/POST_ForceCreditRequestConfiguration_v1_force_credit'
        description: >-
          Any value included in this section will override the corresponding
          value set in the triPOS.config
      displayTransactionAmount:
        description: Display the transaction amount during card read.
        type: boolean
      invokeManualEntry:
        description: ' Invokes manual card entry.'
        type: boolean
      isCscSupported:
        description: >-
          Invokes prompt for cardholder to enter card security code for manual
          keyed card entry.
        type: string
      laneId:
        description: Specifies which lane to use.
        format: int32
        type: integer
      lodging:
        $ref: '#/definitions/POST_LodgingTransactionCompletion_v1_force_credit'
        description: >-
          The lodging parameters to be passed in for a lodging transaction. <a
          href='https://triposcert.vantiv.com/api/help/kb/lodging.html'>more&raquo;</a>
      networkTransactionID:
        description: >-
          The card brand specific transaction ID that should be stored by the
          integrator.
        type: string
      preRead:
        description: >-
          Flag indicating desire to process force credit as PreRead (i.e. - do
          ONLY Pre-Read operations, then expecting next endpoint call to be
          QuickChip) <a
          href='https://triposcert.vantiv.com/api/help/kb/cloud/QuickChipConfiguration.html'>more&raquo;</a>.
        type: boolean
      preReadId:
        $ref: '#/definitions/POST_Guid_v1_force_credit'
        description: >-
          The preReadId returned in the pre-read response. This value should be
          a GUID.<a
          href='..\help\kb\QuickChipWithPreReadId.html'>more&raquo;</a>.
      quickChip:
        description: >-
          Flag indicating desire to process force credit as QuickChip (i.e. -
          Pre-Read has been previously performed) <a
          href='https://triposcert.vantiv.com/api/help/kb/cloud/QuickChipConfiguration.html'>more&raquo;</a>.
        type: boolean
      recurringPaymentType:
        description: Intent of why the credentials are being stored.
        type: string
      referenceNumber:
        description: A user defined reference number.
        type: string
      salesTaxAmount:
        description: >-
          The amount of sales tax for the transaction. This is for Level II,
          submit amount for tax or 0.00 for tax-exempt.
        format: double
        type: number
      shiftId:
        description: An optional shift id for reference.
        type: string
      submissionType:
        description: Specifies the type of transaction.
        type: string
      ticketNumber:
        description: An optional ticket number.
        type: string
      transactionAmount:
        description: >-
          The total transaction amount. This is the amount of funds to move on
          the card
        type: string
    required:
      - approvalNumber
      - laneId
      - transactionAmount
  ForceCreditRequestConfiguration:
    description: ForceCreditRequestConfiguration
    properties:
      allowPartialApprovals:
        description: 'If set to false, partial approvals are not allowed'
        type: boolean
      cardReadRetries:
        description: "Number of retries in case of bad card read. The\_default\_value\_is\_1."
        format: int32
        type: integer
      checkForDuplicateTransactions:
        description: >-
          If set to true, enables duplicate checking logic for the transaction
          at the host.
        type: boolean
      isManualEntryAllowed:
        description: >-
          Use this parameter to allow manual entry of card account numbers on
          the PIN pad.
        type: string
      marketCode:
        description: 'The market code of the transaction. '
        type: string
      promptForSignature:
        description: >-
          Specifies how the signature prompt should be handled for the request.
          If a value is not provided, Never will be used. See <a
          href='https://triposcert.vantiv.com/api/help/kb/signaturePrompt.html'>Signature Prompt</a>.
        type: string
      provisionalAmount:
        description: >-
          Override provisional amount used for QC transactions, which is $1.00
          by default
        type: string
  ForceRequest:
    description: ForceRequest
    properties:
      autoRental:
        $ref: '#/definitions/GET_AutoRental_v1_force'
        description: >-
          The auto rental parameters to be passed in for an auto rental
          transaction. <a href='https://triposcert.vantiv.com/api/help/kb/autorental.html'>more&raquo;</a>
  ForceResponse:
    description: ForceResponse
    properties:
      _errors:
        description: A list of errors that occurred.
        items:
          $ref: '#/definitions/ApiError'
        type: array
      _hasErrors:
        description: Indicates if there are errors.
        type: boolean
      _links:
        description: A list of resource links
        items:
          $ref: '#/definitions/ApiLink'
        type: array
      _logs:
        description: >-
          A list of log entries detailing what happened during the request.
          Ideally only used during development or troubleshooting as this can be
          quite verbose.
        items:
          type: string
        type: array
      _type:
        description: The type of object held in the result.
        type: string
      _warnings:
        description: A list of warnings that occurred.
        items:
          $ref: '#/definitions/ApiWarning'
        type: array
  GET_AutoRentalAdjustmentData_v1_force:
    description: AutoRentalAdjustmentData
    properties:
      amount:
        description: Adjustment amount.
        format: double
        type: number
      code:
        description: >-
          Indicates if adjustment for mileage, fuel, vehicle damage, etc. was
          made to a rental agreement.
        type: string
      extraChargesDetail:
        description: >-
          Pass in up to 6 values that describe the extra charges. For an empty
          or invalid value, this parameter defaults to NoExtraCharge.
        items:
          enum:
            - NoExtraCharge
            - Gasoline
            - ExtraMileage
            - LateReturn
            - OneWayServiceFee
            - ParkingOrMovingViolation
          type: string
        type: array
  GET_AutoRentalPickupData_v1_force:
    description: AutoRentalPickupData
    properties:
      city:
        description: Auto rental pickup city.
        type: string
      countryCode:
        description: 'Country code where vehicle was picked up. For US, use 840.'
        type: string
      date:
        description: 'return date in yyyy-MM-ddTHH:mm:ss format.'
        type: string
      location:
        description: Name of business where vehicle was picked up.
        type: string
      state:
        description: >-
          Abbreviation of state, province, or other country subdivision where
          vehicle was picked up.
        type: string
  GET_AutoRentalReturnData_v1_force:
    description: AutoRentalReturnData
    properties:
      city:
        description: Auto rental return city.
        type: string
      countryCode:
        description: 'Country code where vehicle was returned. For US, use 840.'
        type: string
      date:
        description: 'return date in yyyy-MM-ddTHH:mm:ss format.'
        type: string
      distance:
        description: Numeric distance traveled during rental period.
        format: int32
        type: integer
      distanceUnit:
        description: Unit of measurement applicable to distance traveled.
        type: string
      locationId:
        description: Auto Rental location ID where vehicle was returned.
        type: string
      state:
        description: Auto rental return state.
        type: string
  GET_AutoRental_v1_force:
    description: AutoRental
    properties:
      adjustmentData:
        $ref: '#/definitions/GET_AutoRentalAdjustmentData_v1_force'
        description: Data related to any auto rental adjustments.
      agreementNumber:
        description: Agreement number.
        type: string
      customerName:
        description: Customer Name.
        type: string
      dailyRentalRate:
        description: >-
          Rate charged per day Visa/MC – Daily rate required for Corp T&E rate
          III.
        format: double
        type: number
      duration:
        description: >-
          The number of rental days. Value should be between 0 and 99. Set to 01
          for no show rentals.
        format: int32
        type: integer
      insuranceCharges:
        description: 'If insurance is charged, the insurance amount should be provided.'
        format: double
        type: number
      noShowIndicator:
        description: >-
          No show indicator. Indicates whether rental vehicle was reserved, but
          not actually rented.
        type: string
      pickupData:
        $ref: '#/definitions/GET_AutoRentalPickupData_v1_force'
        description: Data related to autorental pickup.
      returnData:
        $ref: '#/definitions/GET_AutoRentalReturnData_v1_force'
        description: Data related to autorental return.
      vehicleClassCode:
        description: Classification of rental vehicle
        type: string
      weeklyRentalRate:
        description: >-
          Rate charged per week Visa/MC – Weekly rate required for Corp T&E rate
          III.
        format: double
        type: number
  GET_BarcodeRequest_v1_barcode_laneId:
    description: BarcodeRequest
  GET_BinQueryRequest_v1_binQuery_laneId:
    description: BinQueryRequest
    properties:
      invokeManualEntry:
        description: The flag that invokes manual entry directly.
        type: boolean
  GET_CardDiscoveryRequest_v1_card:
    description: CardDiscoveryRequest
    properties:
      laneId:
        description: Specifies which lane to use.
        format: int32
        type: integer
    required:
      - laneId
  GET_CardDiscoveryRequest_v1_pinpad_card:
    description: CardDiscoveryRequest
    properties:
      laneId:
        description: Specifies which lane to use.
        format: int32
        type: integer
    required:
      - laneId
  GET_CardRequest_v1_card_laneId:
    description: CardRequest
    properties:
      invokeManualEntry:
        description: The flag that invokes manual entry directly.
        type: boolean
  GET_CardRequest_v1_pinpad_card_laneId:
    description: CardRequest
    properties:
      invokeManualEntry:
        description: The flag that invokes manual entry directly.
        type: boolean
  GET_FinancialCardDiscoveryRequest_v1_card_financial:
    description: FinancialCardDiscoveryRequest
    properties:
      laneId:
        description: Specifies which lane to use.
        format: int32
        type: integer
    required:
      - laneId
  GET_FinancialCardDiscoveryRequest_v1_pinpad_card_financial:
    description: FinancialCardDiscoveryRequest
    properties:
      laneId:
        description: Specifies which lane to use.
        format: int32
        type: integer
    required:
      - laneId
  GET_FinancialCardRequest_v1_card_financial_laneId:
    description: FinancialCardRequest
    properties:
      invokeManualEntry:
        description: The flag that invokes manual entry directly.
        type: boolean
  GET_FinancialCardRequest_v1_pinpad_card_financial_laneId:
    description: FinancialCardRequest
    properties:
      invokeManualEntry:
        description: The flag that invokes manual entry directly.
        type: boolean
  GET_ForceRequest_v1_force:
    description: ForceRequest
    properties:
      autoRental:
        $ref: '#/definitions/GET_AutoRental_v1_force'
        description: >-
          The auto rental parameters to be passed in for an auto rental
          transaction. <a href='https://triposcert.vantiv.com/api/help/kb/autorental.html'>more&raquo;</a>
  GET_GetLaneSignatureRequest_v1_signature_laneId:
    description: GetLaneSignatureRequest
    properties:
      gotoIdle:
        type: boolean
  GET_GetServicesRequest_v1:
    description: GetServicesRequest
    properties:
      acceptorId:
        description: >-
          The Express acceptorId. If all three Express credentials are specified
          in the request headers, triPOS will use these credentials instead of
          the credentials in the triPOS.config for that request only.
        type: string
      accountId:
        description: >-
          The Express accountId. If all three Express credentials are specified
          in the request headers, triPOS will use these credentials instead of
          the credentials in the triPOS.config for that request only.
        type: string
      accountToken:
        description: >-
          The Express accountToken. If all three Express credentials are
          specified in the request headers, triPOS will use these credentials
          instead of the credentials in the triPOS.config for that request only.
        type: string
      applicationId:
        description: The ID of the business application.
        type: string
      applicationName:
        description: The name of the business application.
        type: string
      applicationVersion:
        description: The version of the business application.
        type: string
      authorizationSignature:
        description: The authorization header.
        type: string
      ctafObject:
        type: boolean
      laneLock:
        $ref: '#/definitions/GET_ILaneLock_v1'
      request:
        type: string
      requestId:
        description: >-
          A unique ID for this request. This value should be a UUID or GUID. <a
          href='https://triposcert.vantiv.com/api/help/kb/requestid.html'>more&raquo;</a>
        type: string
      requestIdAsGuid:
        $ref: '#/definitions/GET_Guid_v1'
      returnLogs:
        description: Set to true to have logs populated in the response.
        type: boolean
    required:
      - acceptorId
      - accountId
      - accountToken
      - applicationId
      - applicationName
      - applicationVersion
      - authorizationSignature
      - ctafObject
      - laneLock
      - request
      - requestId
      - requestIdAsGuid
  GET_GiftRequest_v1_gift:
    description: GiftRequest
    properties:
      acceptorId:
        description: >-
          The Express acceptorId. If all three Express credentials are specified
          in the request headers, triPOS will use these credentials instead of
          the credentials in the triPOS.config for that request only.
        type: string
      accountId:
        description: >-
          The Express accountId. If all three Express credentials are specified
          in the request headers, triPOS will use these credentials instead of
          the credentials in the triPOS.config for that request only.
        type: string
      accountToken:
        description: >-
          The Express accountToken. If all three Express credentials are
          specified in the request headers, triPOS will use these credentials
          instead of the credentials in the triPOS.config for that request only.
        type: string
      applicationId:
        description: The ID of the business application.
        type: string
      applicationName:
        description: The name of the business application.
        type: string
      applicationVersion:
        description: The version of the business application.
        type: string
      authorizationSignature:
        description: The authorization header.
        type: string
      ctafObject:
        type: boolean
      laneLock:
        $ref: '#/definitions/GET_ILaneLock_v1_gift'
      request:
        type: string
      requestId:
        description: >-
          A unique ID for this request. This value should be a UUID or GUID. <a
          href='https://triposcert.vantiv.com/api/help/kb/requestid.html'>more&raquo;</a>
        type: string
      requestIdAsGuid:
        $ref: '#/definitions/GET_Guid_v1_gift'
      returnLogs:
        description: Set to true to have logs populated in the response.
        type: boolean
    required:
      - acceptorId
      - accountId
      - accountToken
      - applicationId
      - applicationName
      - applicationVersion
      - authorizationSignature
      - ctafObject
      - laneLock
      - request
      - requestId
      - requestIdAsGuid
  GET_Guid_v1:
    description: Guid
  GET_Guid_v1_gift:
    description: Guid
  GET_Guid_v1_status:
    description: Guid
  GET_Guid_v1_status_host:
    description: Guid
  GET_HostStatusRequest_v1_status_host:
    description: HostStatusRequest
    properties:
      acceptorId:
        description: >-
          The Express acceptorId. If all three Express credentials are specified
          in the request headers, triPOS will use these credentials instead of
          the credentials in the triPOS.config for that request only.
        type: string
      accountId:
        description: >-
          The Express accountId. If all three Express credentials are specified
          in the request headers, triPOS will use these credentials instead of
          the credentials in the triPOS.config for that request only.
        type: string
      accountToken:
        description: >-
          The Express accountToken. If all three Express credentials are
          specified in the request headers, triPOS will use these credentials
          instead of the credentials in the triPOS.config for that request only.
        type: string
      applicationId:
        description: The ID of the business application.
        type: string
      applicationName:
        description: The name of the business application.
        type: string
      applicationVersion:
        description: The version of the business application.
        type: string
      authorizationSignature:
        description: The authorization header.
        type: string
      ctafObject:
        type: boolean
      laneLock:
        $ref: '#/definitions/GET_ILaneLock_v1_status_host'
      request:
        type: string
      requestId:
        description: >-
          A unique ID for this request. This value should be a UUID or GUID. <a
          href='https://triposcert.vantiv.com/api/help/kb/requestid.html'>more&raquo;</a>
        type: string
      requestIdAsGuid:
        $ref: '#/definitions/GET_Guid_v1_status_host'
      returnLogs:
        description: Set to true to have logs populated in the response.
        type: boolean
    required:
      - acceptorId
      - accountId
      - accountToken
      - applicationId
      - applicationName
      - applicationVersion
      - authorizationSignature
      - ctafObject
      - laneLock
      - request
      - requestId
      - requestIdAsGuid
  GET_ILaneLock_v1:
    description: ILaneLock
    properties:
      id:
        $ref: '#/definitions/GET_Guid_v1'
    required:
      - id
  GET_ILaneLock_v1_gift:
    description: ILaneLock
    properties:
      id:
        $ref: '#/definitions/GET_Guid_v1_gift'
    required:
      - id
  GET_ILaneLock_v1_status:
    description: ILaneLock
    properties:
      id:
        $ref: '#/definitions/GET_Guid_v1_status'
    required:
      - id
  GET_ILaneLock_v1_status_host:
    description: ILaneLock
    properties:
      id:
        $ref: '#/definitions/GET_Guid_v1_status_host'
    required:
      - id
  GET_InputRequest_v1_input_laneId:
    description: InputRequest
  GET_NonFinancialCardDiscoveryRequest_v1_card_nonfinancial:
    description: NonFinancialCardDiscoveryRequest
    properties:
      laneId:
        description: Specifies which lane to use.
        format: int32
        type: integer
    required:
      - laneId
  GET_NonFinancialCardDiscoveryRequest_v1_pinpad_card_nonfinancial:
    description: NonFinancialCardDiscoveryRequest
    properties:
      laneId:
        description: Specifies which lane to use.
        format: int32
        type: integer
    required:
      - laneId
  GET_NonFinancialCardRequest_v1_card_nonfinancial_laneId:
    description: NonFinancialCardRequest
    properties:
      invokeManualEntry:
        description: The flag that invokes manual entry directly.
        type: boolean
  GET_NonFinancialCardRequest_v1_pinpad_card_nonfinancial_laneId:
    description: NonFinancialCardRequest
    properties:
      invokeManualEntry:
        description: The flag that invokes manual entry directly.
        type: boolean
  GET_PinPadSelectionRequest_v1_pinPadSelectionPrompt:
    description: PinPadSelectionRequest
  GET_SelectionDiscoveryRequest_v1_selection:
    description: SelectionDiscoveryRequest
    properties:
      laneId:
        description: Specifies which lane to use.
        format: int32
        type: integer
    required:
      - laneId
  GET_SelectionRequest_v1_selection_laneId:
    description: SelectionRequest
  GET_SignatureRequest_v1_signature:
    description: SignatureRequest
    properties:
      laneId:
        description: Specifies which lane to use.
        format: int32
        type: integer
    required:
      - laneId
  GET_StatusRequest_v1_status:
    description: StatusRequest
    properties:
      acceptorId:
        description: >-
          The Express acceptorId. If all three Express credentials are specified
          in the request headers, triPOS will use these credentials instead of
          the credentials in the triPOS.config for that request only.
        type: string
      accountId:
        description: >-
          The Express accountId. If all three Express credentials are specified
          in the request headers, triPOS will use these credentials instead of
          the credentials in the triPOS.config for that request only.
        type: string
      accountToken:
        description: >-
          The Express accountToken. If all three Express credentials are
          specified in the request headers, triPOS will use these credentials
          instead of the credentials in the triPOS.config for that request only.
        type: string
      applicationId:
        description: The ID of the business application.
        type: string
      applicationName:
        description: The name of the business application.
        type: string
      applicationVersion:
        description: The version of the business application.
        type: string
      authorizationSignature:
        description: The authorization header.
        type: string
      ctafObject:
        type: boolean
      laneLock:
        $ref: '#/definitions/GET_ILaneLock_v1_status'
      request:
        type: string
      requestId:
        description: >-
          A unique ID for this request. This value should be a UUID or GUID. <a
          href='https://triposcert.vantiv.com/api/help/kb/requestid.html'>more&raquo;</a>
        type: string
      requestIdAsGuid:
        $ref: '#/definitions/GET_Guid_v1_status'
      returnLogs:
        description: Set to true to have logs populated in the response.
        type: boolean
    required:
      - acceptorId
      - accountId
      - accountToken
      - applicationId
      - applicationName
      - applicationVersion
      - authorizationSignature
      - ctafObject
      - laneLock
      - request
      - requestId
      - requestIdAsGuid
  GET_TriPosStatusRequest_v1_status_triPOS_echo:
    description: TriPosStatusRequest
  GetLaneSignatureRequest:
    description: GetLaneSignatureRequest
    properties:
      gotoIdle:
        type: boolean
  GetLaneSignatureResponse:
    description: GetLaneSignatureResponse
    properties:
      _errors:
        description: A list of errors that occurred.
        items:
          $ref: '#/definitions/ApiError'
        type: array
      _hasErrors:
        description: Indicates if there are errors.
        type: boolean
      _links:
        description: A list of resource links
        items:
          $ref: '#/definitions/ApiLink'
        type: array
      _logs:
        description: >-
          A list of log entries detailing what happened during the request.
          Ideally only used during development or troubleshooting as this can be
          quite verbose.
        items:
          type: string
        type: array
      _type:
        description: The type of object held in the result.
        type: string
      _warnings:
        description: A list of warnings that occurred.
        items:
          $ref: '#/definitions/ApiWarning'
        type: array
      laneId:
        description: The lane ID.
        format: int32
        type: integer
      signature:
        $ref: '#/definitions/Signature'
        description: Signature data returned from the pinpad.
  GetServicesRequest:
    description: GetServicesRequest
    properties:
      acceptorId:
        description: >-
          The Express acceptorId. If all three Express credentials are specified
          in the request headers, triPOS will use these credentials instead of
          the credentials in the triPOS.config for that request only.
        type: string
      accountId:
        description: >-
          The Express accountId. If all three Express credentials are specified
          in the request headers, triPOS will use these credentials instead of
          the credentials in the triPOS.config for that request only.
        type: string
      accountToken:
        description: >-
          The Express accountToken. If all three Express credentials are
          specified in the request headers, triPOS will use these credentials
          instead of the credentials in the triPOS.config for that request only.
        type: string
      applicationId:
        description: The ID of the business application.
        type: string
      applicationName:
        description: The name of the business application.
        type: string
      applicationVersion:
        description: The version of the business application.
        type: string
      authorizationSignature:
        description: The authorization header.
        type: string
      ctafObject:
        type: boolean
      laneLock:
        $ref: '#/definitions/GET_ILaneLock_v1'
      request:
        type: string
      requestId:
        description: >-
          A unique ID for this request. This value should be a UUID or GUID. <a
          href='https://triposcert.vantiv.com/api/help/kb/requestid.html'>more&raquo;</a>
        type: string
      requestIdAsGuid:
        $ref: '#/definitions/GET_Guid_v1'
      returnLogs:
        description: Set to true to have logs populated in the response.
        type: boolean
    required:
      - acceptorId
      - accountId
      - accountToken
      - applicationId
      - applicationName
      - applicationVersion
      - authorizationSignature
      - ctafObject
      - laneLock
      - request
      - requestId
      - requestIdAsGuid
  GetServicesResponse:
    description: GetServicesResponse
    properties:
      _errors:
        description: A list of errors that occurred.
        items:
          $ref: '#/definitions/ApiError'
        type: array
      _hasErrors:
        description: Indicates if there are errors.
        type: boolean
      _links:
        description: A list of resource links
        items:
          $ref: '#/definitions/ApiLink'
        type: array
      _logs:
        description: >-
          A list of log entries detailing what happened during the request.
          Ideally only used during development or troubleshooting as this can be
          quite verbose.
        items:
          type: string
        type: array
      _type:
        description: The type of object held in the result.
        type: string
      _warnings:
        description: A list of warnings that occurred.
        items:
          $ref: '#/definitions/ApiWarning'
        type: array
  GiftRequest:
    description: GiftRequest
    properties:
      acceptorId:
        description: >-
          The Express acceptorId. If all three Express credentials are specified
          in the request headers, triPOS will use these credentials instead of
          the credentials in the triPOS.config for that request only.
        type: string
      accountId:
        description: >-
          The Express accountId. If all three Express credentials are specified
          in the request headers, triPOS will use these credentials instead of
          the credentials in the triPOS.config for that request only.
        type: string
      accountToken:
        description: >-
          The Express accountToken. If all three Express credentials are
          specified in the request headers, triPOS will use these credentials
          instead of the credentials in the triPOS.config for that request only.
        type: string
      applicationId:
        description: The ID of the business application.
        type: string
      applicationName:
        description: The name of the business application.
        type: string
      applicationVersion:
        description: The version of the business application.
        type: string
      authorizationSignature:
        description: The authorization header.
        type: string
      ctafObject:
        type: boolean
      laneLock:
        $ref: '#/definitions/GET_ILaneLock_v1_gift'
      request:
        type: string
      requestId:
        description: >-
          A unique ID for this request. This value should be a UUID or GUID. <a
          href='https://triposcert.vantiv.com/api/help/kb/requestid.html'>more&raquo;</a>
        type: string
      requestIdAsGuid:
        $ref: '#/definitions/GET_Guid_v1_gift'
      returnLogs:
        description: Set to true to have logs populated in the response.
        type: boolean
    required:
      - acceptorId
      - accountId
      - accountToken
      - applicationId
      - applicationName
      - applicationVersion
      - authorizationSignature
      - ctafObject
      - laneLock
      - request
      - requestId
      - requestIdAsGuid
  GiftResponse:
    description: GiftResponse
    properties:
      _errors:
        description: A list of errors that occurred.
        items:
          $ref: '#/definitions/ApiError'
        type: array
      _hasErrors:
        description: Indicates if there are errors.
        type: boolean
      _links:
        description: A list of resource links
        items:
          $ref: '#/definitions/ApiLink'
        type: array
      _logs:
        description: >-
          A list of log entries detailing what happened during the request.
          Ideally only used during development or troubleshooting as this can be
          quite verbose.
        items:
          type: string
        type: array
      _type:
        description: The type of object held in the result.
        type: string
      _warnings:
        description: A list of warnings that occurred.
        items:
          $ref: '#/definitions/ApiWarning'
        type: array
  Guid:
    description: Guid
  Healthcare:
    description: Healthcare
    properties:
      clinic:
        description: >-
          The total amount of healthcare-qualified goods that fall into the
          category of 'clinic'.
        format: double
        type: number
      dental:
        description: >-
          The total amount of healthcare-qualified goods that fall into the
          category of 'dental'.
        format: double
        type: number
      prescription:
        description: >-
          The total amount of healthcare-qualified goods that fall into the
          category of 'prescription'.
        format: double
        type: number
      total:
        description: >-
          The total amount of healthcare-qualified goods. If any healthcare
          values are included, this value is required to be present.
        format: double
        type: number
      vision:
        description: >-
          The total amount of healthcare-qualified goods that fall into the
          category of 'vision'.
        format: double
        type: number
  HostStatusRequest:
    description: HostStatusRequest
    properties:
      acceptorId:
        description: >-
          The Express acceptorId. If all three Express credentials are specified
          in the request headers, triPOS will use these credentials instead of
          the credentials in the triPOS.config for that request only.
        type: string
      accountId:
        description: >-
          The Express accountId. If all three Express credentials are specified
          in the request headers, triPOS will use these credentials instead of
          the credentials in the triPOS.config for that request only.
        type: string
      accountToken:
        description: >-
          The Express accountToken. If all three Express credentials are
          specified in the request headers, triPOS will use these credentials
          instead of the credentials in the triPOS.config for that request only.
        type: string
      applicationId:
        description: The ID of the business application.
        type: string
      applicationName:
        description: The name of the business application.
        type: string
      applicationVersion:
        description: The version of the business application.
        type: string
      authorizationSignature:
        description: The authorization header.
        type: string
      ctafObject:
        type: boolean
      laneLock:
        $ref: '#/definitions/GET_ILaneLock_v1_status_host'
      request:
        type: string
      requestId:
        description: >-
          A unique ID for this request. This value should be a UUID or GUID. <a
          href='https://triposcert.vantiv.com/api/help/kb/requestid.html'>more&raquo;</a>
        type: string
      requestIdAsGuid:
        $ref: '#/definitions/GET_Guid_v1_status_host'
      returnLogs:
        description: Set to true to have logs populated in the response.
        type: boolean
    required:
      - acceptorId
      - accountId
      - accountToken
      - applicationId
      - applicationName
      - applicationVersion
      - authorizationSignature
      - ctafObject
      - laneLock
      - request
      - requestId
      - requestIdAsGuid
  HostStatusResponse:
    description: HostStatusResponse
    properties:
      _errors:
        description: A list of errors that occurred.
        items:
          $ref: '#/definitions/ApiError'
        type: array
      _hasErrors:
        description: Indicates if there are errors.
        type: boolean
      _links:
        description: A list of resource links
        items:
          $ref: '#/definitions/ApiLink'
        type: array
      _logs:
        description: >-
          A list of log entries detailing what happened during the request.
          Ideally only used during development or troubleshooting as this can be
          quite verbose.
        items:
          type: string
        type: array
      _processor:
        $ref: '#/definitions/Processor'
        description: Response information from the processor.
      _type:
        description: The type of object held in the result.
        type: string
      _warnings:
        description: A list of warnings that occurred.
        items:
          $ref: '#/definitions/ApiWarning'
        type: array
      hostStatus:
        description: The status of the connection between triPOS and the host.
        type: string
      merchantId:
        description: The merchant ID.
        type: string
      transactionDateTime:
        description: Transaction date/time in ISO8601 format
        type: string
  IEqualityComparer_String:
    description: IEqualityComparer`String`
  IEqualityComparer`String`:
    description: IEqualityComparer`String`
  ILaneLock:
    description: ILaneLock
    properties:
      id:
        $ref: '#/definitions/GET_Guid_v1'
    required:
      - id
  IdleRequest:
    description: IdleRequest
    properties:
      laneId:
        description: Specifies which lane to use.
        format: int32
        type: integer
    required:
      - laneId
  IdleResponse:
    description: IdleResponse
    properties:
      _errors:
        description: A list of errors that occurred.
        items:
          $ref: '#/definitions/ApiError'
        type: array
      _hasErrors:
        description: Indicates if there are errors.
        type: boolean
      _links:
        description: A list of resource links
        items:
          $ref: '#/definitions/ApiLink'
        type: array
      _logs:
        description: >-
          A list of log entries detailing what happened during the request.
          Ideally only used during development or troubleshooting as this can be
          quite verbose.
        items:
          type: string
        type: array
      _type:
        description: The type of object held in the result.
        type: string
      _warnings:
        description: A list of warnings that occurred.
        items:
          $ref: '#/definitions/ApiWarning'
        type: array
  IncrementalAuthorizationRequest:
    description: IncrementalAuthorizationRequest
    properties:
      autoRental:
        $ref: >-
          #/definitions/POST_AutoRentalBasic_v1_authorization_transactionId_incremental
        description: >-
          The auto rental parameters to be passed in for an auto rental
          transaction. <a href='https://triposcert.vantiv.com/api/help/kb/autorental.html'>more&raquo;</a>
      cardHolderPresentCode:
        description: >-
          Defines whether the cardholder is present at the transaction. This
          value is optional, but recommended to be set. If this value is not set
          in the request, it will be automatically set based on the market code.
        type: string
      clerkNumber:
        description: An optional clerk number for reference.
        type: string
      configuration:
        $ref: >-
          #/definitions/POST_TransactionIdRequestConfiguration_v1_authorization_transactionId_incremental
        description: Applicable configuration values that can be set per request.
      estimatedAmountIndicator:
        description: >-
          The EstimatedAmountIndicator can be used by merchants/integrators to
          define the TransactionAmount submitted to Express either as an
          Estimated Amount (i.e. amount to charge cardholder may change) or a
          Final Amount (i.e. amount to charge cardholder will not change).  It
          will be a 1-character request field supporting the following request
          settings:
        type: string
      getToken:
        description: >-
          To retrieve Token in the transaction. <a
          href='https://triposcert.vantiv.com/api/help/kb/GetToken.html'>more&raquo;</a>
        type: string
      laneId:
        description: Specifies which lane to use.
        format: int32
        type: integer
      lodging:
        $ref: >-
          #/definitions/POST_LodgingIncrementalAuthorization_v1_authorization_transactionId_incremental
        description: >-
          The lodging parameter to be passed in for a lodging transaction. <a
          href='https://triposcert.vantiv.com/api/help/kb/lodging.html'>more&raquo;</a>
      referenceNumber:
        description: A user defined reference number.
        type: string
      shiftId:
        description: An optional shift id for reference.
        type: string
      ticketNumber:
        description: An optional ticket number.
        type: string
      transactionAmount:
        description: The amount by which to increase the authorization amount.
        format: double
        type: number
    required:
      - laneId
      - transactionAmount
  IncrementalAuthorizationResponse:
    description: IncrementalAuthorizationResponse
    properties:
      _errors:
        description: A list of errors that occurred.
        items:
          $ref: '#/definitions/ApiError'
        type: array
      _hasErrors:
        description: Indicates if there are errors.
        type: boolean
      _links:
        description: A list of resource links
        items:
          $ref: '#/definitions/ApiLink'
        type: array
      _logs:
        description: >-
          A list of log entries detailing what happened during the request.
          Ideally only used during development or troubleshooting as this can be
          quite verbose.
        items:
          type: string
        type: array
      _processor:
        $ref: '#/definitions/Processor'
        description: Response information from the processor.
      _type:
        description: The type of object held in the result.
        type: string
      _warnings:
        description: A list of warnings that occurred.
        items:
          $ref: '#/definitions/ApiWarning'
        type: array
      accountNumber:
        description: The card account number.
        type: string
      approvalNumber:
        description: >-
          Approval number from the processor. Depending on card type and
          processor an approval number might not be returned.
        type: string
      cardLogo:
        description: >-
          The card logo. Possible values are: Visa, Mastercard, Discover, Amex,
          Diners Club, JCB, Carte Blanche, Other.
        type: string
      isApproved:
        description: Set to true if the host approved the transaction.
        type: boolean
      isOffline:
        description: >-
          A boolean value indicating whether triPOS is disconnected from the
          host.
        type: boolean
      marketCode:
        description: 'The market code of the transaction. '
        type: string
      merchantId:
        description: The Merchant used to process the transaction.
        type: string
      referenceNumber:
        description: The transaction's reference number.
        type: string
      statusCode:
        description: The status code for the transaction.
        type: string
      terminalId:
        description: The ID of the terminal used during the transaction
        type: string
      tokenId:
        description: The Token ID.
        type: string
      tokenProvider:
        description: The Token Provider.
        type: string
      totalAmount:
        description: The total amount of the transaction.
        format: double
        type: number
      transactionDateTime:
        description: Transaction date/time in ISO8601 format
        type: string
      transactionId:
        description: The transaction ID from the processor
        type: string
  InputRequest:
    description: InputRequest
  InputResponse:
    description: InputResponse
    properties:
      _errors:
        description: A list of errors that occurred.
        items:
          $ref: '#/definitions/ApiError'
        type: array
      _hasErrors:
        description: Indicates if there are errors.
        type: boolean
      _links:
        description: A list of resource links
        items:
          $ref: '#/definitions/ApiLink'
        type: array
      _logs:
        description: >-
          A list of log entries detailing what happened during the request.
          Ideally only used during development or troubleshooting as this can be
          quite verbose.
        items:
          type: string
        type: array
      _type:
        description: The type of object held in the result.
        type: string
      _warnings:
        description: A list of warnings that occurred.
        items:
          $ref: '#/definitions/ApiWarning'
        type: array
      cardholderAction:
        description: The cardholder interaction with the PIN pad.
        type: string
      inputText:
        description: >-
          The raw, unformatted text that the cardholder entered into the input
          field on the PIN pad.
        type: string
  LodgingAuthorization:
    description: LodgingAuthorization
    properties:
      duration:
        description: The number of hotel stay days. Set to 1 for no show.
        format: int32
        type: integer
      prestigiousPropertyCode:
        description: >-
          The lodging prestigious property code. For an empty or invalid value,
          this parameter defaults to NonParticipant.
        type: string
  LodgingIncrementalAuthorization:
    description: LodgingIncrementalAuthorization
    properties:
      duration:
        description: The number of hotel stay days. Set to 1 for no show.
        format: int32
        type: integer
  LodgingTransactionCompletion:
    description: LodgingTransactionCompletion
    properties:
      agreementNumber:
        description: The lodging agreement number.
        type: string
      chargeType:
        description: >-
          The lodging charge type. For an empty or invalid value, this parameter
          defaults to Default.
        type: string
      checkInDate:
        description: >-
          The check-in date for the lodging stay. Must be in the ISO 8601 format
          of YYYY-MM-DD.
        type: string
      checkOutDate:
        description: >-
          The check-out date for the lodging stay. Must be in the ISO 8601
          format of YYYY-MM-DD.
        type: string
      customerName:
        description: The lodging customer name.
        type: string
      duration:
        description: The number of hotel stay days. Set to 1 for no show.
        format: int32
        type: integer
      extraChargesDetail:
        description: >-
          Pass in up to 6 values that describe the extra charges. For an empty
          or invalid value, this parameter defaults to NotUsed.
        items:
          enum:
            - NotUsed
            - Reserved
            - Restaurant
            - GiftShop
            - MiniBar
            - Telephone
            - Other
            - Laundry
          type: string
        type: array
      noShow:
        description: 'Set to true to indicate no show. Otherwise, value defaults to false.'
        type: boolean
      prestigiousPropertyCode:
        description: >-
          The lodging prestigious property code. For an empty or invalid value,
          this parameter defaults to NonParticipant.
        type: string
      roomAmount:
        description: The nightly rate for one room.
        format: double
        type: number
      specialProgramCode:
        description: >-
          The lodging special program code. For an empty or invalid value, this
          parameter defaults to Default.
        type: string
  NonFinancialCard:
    description: NonFinancialCard
    properties:
      cardEntryMode:
        description: Card entry mode
        type: string
      track1:
        description: Track 1 of the non-financial card
        type: string
      track2:
        description: Track 2 of the non-financial card
        type: string
      track3:
        description: Track 3 of the non-financial card
        type: string
  NonFinancialCardDiscoveryRequest:
    description: NonFinancialCardDiscoveryRequest
    properties:
      laneId:
        description: Specifies which lane to use.
        format: int32
        type: integer
    required:
      - laneId
  NonFinancialCardRequest:
    description: NonFinancialCardRequest
    properties:
      invokeManualEntry:
        description: The flag that invokes manual entry directly.
        type: boolean
  NonFinancialCardResponse:
    description: NonFinancialCardResponse
    properties:
      _errors:
        description: A list of errors that occurred.
        items:
          $ref: '#/definitions/ApiError'
        type: array
      _hasErrors:
        description: Indicates if there are errors.
        type: boolean
      _links:
        description: A list of resource links
        items:
          $ref: '#/definitions/ApiLink'
        type: array
      _logs:
        description: >-
          A list of log entries detailing what happened during the request.
          Ideally only used during development or troubleshooting as this can be
          quite verbose.
        items:
          type: string
        type: array
      _type:
        description: The type of object held in the result.
        type: string
      _warnings:
        description: A list of warnings that occurred.
        items:
          $ref: '#/definitions/ApiWarning'
        type: array
      cardEntryMode:
        description: Card entry mode
        type: string
      track1:
        description: Track 1 of the non-financial card
        type: string
      track2:
        description: Track 2 of the non-financial card
        type: string
      track3:
        description: Track 3 of the non-financial card
        type: string
  Nullable`Boolean`:
    description: Nullable`Boolean`
    properties:
      hasValue:
        type: boolean
      value:
        type: boolean
    required:
      - hasValue
      - value
  Nullable`Decimal`:
    description: Nullable`Decimal`
    properties:
      hasValue:
        type: boolean
      value:
        format: double
        type: number
    required:
      - hasValue
      - value
  Nullable`Int32`:
    description: Nullable`Int32`
    properties:
      hasValue:
        type: boolean
      value:
        format: int32
        type: integer
    required:
      - hasValue
      - value
  POST_ActivateGiftRequest_v1_gift_activate:
    description: ActivateGiftRequest
    properties:
      cardHolderPresentCode:
        description: >-
          Defines whether the cardholder is present at the transaction. This
          value is optional, but recommended to be set. If this value is not set
          in the request, it will be automatically set based on the market code.
        type: string
      clerkNumber:
        description: An optional clerk number for reference.
        type: string
      configuration:
        $ref: '#/definitions/POST_RequestConfiguration_v1_gift_activate'
        description: >-
          Any value included in this section will override the corresponding
          value set in the triPOS.config
      giftCardProgram:
        description: >-
          This field is for Valutec gift/loyalty card program. <br>'01' =
          Original Gift Card Program <br>'02' = Promotional Gift Card Program
          <br>'03' = Original Combo Card Program <br>'04' = Auto Rewards LPR
          Card Program <br>'05' = Original Loyalty Card Program
        type: string
      giftProgramType:
        description: >-
          This field is for Valutec gift/loyalty card type. The value 0 is for
          gift and 1 for loyalty
        type: string
      invokeManualEntry:
        description: ' Invokes manual card entry.'
        type: boolean
      isCscSupported:
        description: >-
          Invokes prompt for cardholder to enter card security code for manual
          keyed card entry.
        type: string
      laneId:
        description: Specifies which lane to use.
        format: int32
        type: integer
      referenceNumber:
        description: A user defined reference number.
        type: string
      shiftId:
        description: An optional shift id for reference.
        type: string
      storeCard:
        $ref: '#/definitions/POST_StoreCard_v1_gift_activate'
        description: Information necessary to process a StoreCard transaction.
      ticketNumber:
        description: An optional ticket number.
        type: string
      transactionAmount:
        description: >-
          The total transaction amount. This is the amount of funds to move on
          the card
        format: double
        type: number
    required:
      - laneId
      - transactionAmount
  POST_Address_v1_authorization:
    description: Address
    properties:
      billingAddress1:
        description: The street address used for billing purposes.
        type: string
      billingAddress2:
        description: The street address used for billing purposes.
        type: string
      billingCity:
        description: The name of the city used for billing purposes.
        type: string
      billingEmail:
        description: The e-mail address used for billing purposes.
        type: string
      billingName:
        description: The name used for billing purposes.
        type: string
      billingPhone:
        description: >-
          The phone number used for billing purposes. The recommended format is
          (800)555-1212.
        type: string
      billingPostalCode:
        description: The postal code used for billing purposes.
        type: string
      billingState:
        description: >-
          The name of the state used for billing purposes. This value may be any
          2 character state code or the full state name.
        type: string
      shippingAddress1:
        description: The street address used for shipping purposes.
        type: string
      shippingAddress2:
        description: The street address used for shipping purposes.
        type: string
      shippingCity:
        description: The name of the city used for shipping purposes.
        type: string
      shippingEmail:
        description: The e-mail address used for shipping purposes.
        type: string
      shippingName:
        description: The name used for shipping purposes.
        type: string
      shippingPhone:
        description: >-
          The phone number used for shipping purposes. The recommended format is
          (800)555-1212
        type: string
      shippingPostalCode:
        description: The postal code used for shipping purposes.
        type: string
      shippingState:
        description: >-
          The name of the state used for shipping purposes. This value may be
          any 2 character state code or the full state name.
        type: string
  POST_Address_v1_authorization_paymentAccountId:
    description: Address
    properties:
      billingAddress1:
        description: The street address used for billing purposes.
        type: string
      billingAddress2:
        description: The street address used for billing purposes.
        type: string
      billingCity:
        description: The name of the city used for billing purposes.
        type: string
      billingEmail:
        description: The e-mail address used for billing purposes.
        type: string
      billingName:
        description: The name used for billing purposes.
        type: string
      billingPhone:
        description: >-
          The phone number used for billing purposes. The recommended format is
          (800)555-1212.
        type: string
      billingPostalCode:
        description: The postal code used for billing purposes.
        type: string
      billingState:
        description: >-
          The name of the state used for billing purposes. This value may be any
          2 character state code or the full state name.
        type: string
      shippingAddress1:
        description: The street address used for shipping purposes.
        type: string
      shippingAddress2:
        description: The street address used for shipping purposes.
        type: string
      shippingCity:
        description: The name of the city used for shipping purposes.
        type: string
      shippingEmail:
        description: The e-mail address used for shipping purposes.
        type: string
      shippingName:
        description: The name used for shipping purposes.
        type: string
      shippingPhone:
        description: >-
          The phone number used for shipping purposes. The recommended format is
          (800)555-1212
        type: string
      shippingPostalCode:
        description: The postal code used for shipping purposes.
        type: string
      shippingState:
        description: >-
          The name of the state used for shipping purposes. This value may be
          any 2 character state code or the full state name.
        type: string
  POST_Address_v1_authorization_token:
    description: Address
    properties:
      billingAddress1:
        description: The street address used for billing purposes.
        type: string
      billingAddress2:
        description: The street address used for billing purposes.
        type: string
      billingCity:
        description: The name of the city used for billing purposes.
        type: string
      billingEmail:
        description: The e-mail address used for billing purposes.
        type: string
      billingName:
        description: The name used for billing purposes.
        type: string
      billingPhone:
        description: >-
          The phone number used for billing purposes. The recommended format is
          (800)555-1212.
        type: string
      billingPostalCode:
        description: The postal code used for billing purposes.
        type: string
      billingState:
        description: >-
          The name of the state used for billing purposes. This value may be any
          2 character state code or the full state name.
        type: string
      shippingAddress1:
        description: The street address used for shipping purposes.
        type: string
      shippingAddress2:
        description: The street address used for shipping purposes.
        type: string
      shippingCity:
        description: The name of the city used for shipping purposes.
        type: string
      shippingEmail:
        description: The e-mail address used for shipping purposes.
        type: string
      shippingName:
        description: The name used for shipping purposes.
        type: string
      shippingPhone:
        description: >-
          The phone number used for shipping purposes. The recommended format is
          (800)555-1212
        type: string
      shippingPostalCode:
        description: The postal code used for shipping purposes.
        type: string
      shippingState:
        description: >-
          The name of the state used for shipping purposes. This value may be
          any 2 character state code or the full state name.
        type: string
  POST_Address_v1_authorization_transactionId_completion:
    description: Address
    properties:
      billingAddress1:
        description: The street address used for billing purposes.
        type: string
      billingAddress2:
        description: The street address used for billing purposes.
        type: string
      billingCity:
        description: The name of the city used for billing purposes.
        type: string
      billingEmail:
        description: The e-mail address used for billing purposes.
        type: string
      billingName:
        description: The name used for billing purposes.
        type: string
      billingPhone:
        description: >-
          The phone number used for billing purposes. The recommended format is
          (800)555-1212.
        type: string
      billingPostalCode:
        description: The postal code used for billing purposes.
        type: string
      billingState:
        description: >-
          The name of the state used for billing purposes. This value may be any
          2 character state code or the full state name.
        type: string
      shippingAddress1:
        description: The street address used for shipping purposes.
        type: string
      shippingAddress2:
        description: The street address used for shipping purposes.
        type: string
      shippingCity:
        description: The name of the city used for shipping purposes.
        type: string
      shippingEmail:
        description: The e-mail address used for shipping purposes.
        type: string
      shippingName:
        description: The name used for shipping purposes.
        type: string
      shippingPhone:
        description: >-
          The phone number used for shipping purposes. The recommended format is
          (800)555-1212
        type: string
      shippingPostalCode:
        description: The postal code used for shipping purposes.
        type: string
      shippingState:
        description: >-
          The name of the state used for shipping purposes. This value may be
          any 2 character state code or the full state name.
        type: string
  POST_Address_v1_credit:
    description: Address
    properties:
      billingAddress1:
        description: The street address used for billing purposes.
        type: string
      billingAddress2:
        description: The street address used for billing purposes.
        type: string
      billingCity:
        description: The name of the city used for billing purposes.
        type: string
      billingEmail:
        description: The e-mail address used for billing purposes.
        type: string
      billingName:
        description: The name used for billing purposes.
        type: string
      billingPhone:
        description: >-
          The phone number used for billing purposes. The recommended format is
          (800)555-1212.
        type: string
      billingPostalCode:
        description: The postal code used for billing purposes.
        type: string
      billingState:
        description: >-
          The name of the state used for billing purposes. This value may be any
          2 character state code or the full state name.
        type: string
      shippingAddress1:
        description: The street address used for shipping purposes.
        type: string
      shippingAddress2:
        description: The street address used for shipping purposes.
        type: string
      shippingCity:
        description: The name of the city used for shipping purposes.
        type: string
      shippingEmail:
        description: The e-mail address used for shipping purposes.
        type: string
      shippingName:
        description: The name used for shipping purposes.
        type: string
      shippingPhone:
        description: >-
          The phone number used for shipping purposes. The recommended format is
          (800)555-1212
        type: string
      shippingPostalCode:
        description: The postal code used for shipping purposes.
        type: string
      shippingState:
        description: >-
          The name of the state used for shipping purposes. This value may be
          any 2 character state code or the full state name.
        type: string
  POST_Address_v1_force_credit:
    description: Address
    properties:
      billingAddress1:
        description: The street address used for billing purposes.
        type: string
      billingAddress2:
        description: The street address used for billing purposes.
        type: string
      billingCity:
        description: The name of the city used for billing purposes.
        type: string
      billingEmail:
        description: The e-mail address used for billing purposes.
        type: string
      billingName:
        description: The name used for billing purposes.
        type: string
      billingPhone:
        description: >-
          The phone number used for billing purposes. The recommended format is
          (800)555-1212.
        type: string
      billingPostalCode:
        description: The postal code used for billing purposes.
        type: string
      billingState:
        description: >-
          The name of the state used for billing purposes. This value may be any
          2 character state code or the full state name.
        type: string
      shippingAddress1:
        description: The street address used for shipping purposes.
        type: string
      shippingAddress2:
        description: The street address used for shipping purposes.
        type: string
      shippingCity:
        description: The name of the city used for shipping purposes.
        type: string
      shippingEmail:
        description: The e-mail address used for shipping purposes.
        type: string
      shippingName:
        description: The name used for shipping purposes.
        type: string
      shippingPhone:
        description: >-
          The phone number used for shipping purposes. The recommended format is
          (800)555-1212
        type: string
      shippingPostalCode:
        description: The postal code used for shipping purposes.
        type: string
      shippingState:
        description: >-
          The name of the state used for shipping purposes. This value may be
          any 2 character state code or the full state name.
        type: string
  POST_Address_v1_paymentAccount:
    description: Address
    properties:
      billingAddress1:
        description: The street address used for billing purposes.
        type: string
      billingAddress2:
        description: The street address used for billing purposes.
        type: string
      billingCity:
        description: The name of the city used for billing purposes.
        type: string
      billingEmail:
        description: The e-mail address used for billing purposes.
        type: string
      billingName:
        description: The name used for billing purposes.
        type: string
      billingPhone:
        description: >-
          The phone number used for billing purposes. The recommended format is
          (800)555-1212.
        type: string
      billingPostalCode:
        description: The postal code used for billing purposes.
        type: string
      billingState:
        description: >-
          The name of the state used for billing purposes. This value may be any
          2 character state code or the full state name.
        type: string
      shippingAddress1:
        description: The street address used for shipping purposes.
        type: string
      shippingAddress2:
        description: The street address used for shipping purposes.
        type: string
      shippingCity:
        description: The name of the city used for shipping purposes.
        type: string
      shippingEmail:
        description: The e-mail address used for shipping purposes.
        type: string
      shippingName:
        description: The name used for shipping purposes.
        type: string
      shippingPhone:
        description: >-
          The phone number used for shipping purposes. The recommended format is
          (800)555-1212
        type: string
      shippingPostalCode:
        description: The postal code used for shipping purposes.
        type: string
      shippingState:
        description: >-
          The name of the state used for shipping purposes. This value may be
          any 2 character state code or the full state name.
        type: string
  POST_Address_v1_paymentAccount_credit:
    description: Address
    properties:
      billingAddress1:
        description: The street address used for billing purposes.
        type: string
      billingAddress2:
        description: The street address used for billing purposes.
        type: string
      billingCity:
        description: The name of the city used for billing purposes.
        type: string
      billingEmail:
        description: The e-mail address used for billing purposes.
        type: string
      billingName:
        description: The name used for billing purposes.
        type: string
      billingPhone:
        description: >-
          The phone number used for billing purposes. The recommended format is
          (800)555-1212.
        type: string
      billingPostalCode:
        description: The postal code used for billing purposes.
        type: string
      billingState:
        description: >-
          The name of the state used for billing purposes. This value may be any
          2 character state code or the full state name.
        type: string
      shippingAddress1:
        description: The street address used for shipping purposes.
        type: string
      shippingAddress2:
        description: The street address used for shipping purposes.
        type: string
      shippingCity:
        description: The name of the city used for shipping purposes.
        type: string
      shippingEmail:
        description: The e-mail address used for shipping purposes.
        type: string
      shippingName:
        description: The name used for shipping purposes.
        type: string
      shippingPhone:
        description: >-
          The phone number used for shipping purposes. The recommended format is
          (800)555-1212
        type: string
      shippingPostalCode:
        description: The postal code used for shipping purposes.
        type: string
      shippingState:
        description: >-
          The name of the state used for shipping purposes. This value may be
          any 2 character state code or the full state name.
        type: string
  POST_Address_v1_refund:
    description: Address
    properties:
      billingAddress1:
        description: The street address used for billing purposes.
        type: string
      billingAddress2:
        description: The street address used for billing purposes.
        type: string
      billingCity:
        description: The name of the city used for billing purposes.
        type: string
      billingEmail:
        description: The e-mail address used for billing purposes.
        type: string
      billingName:
        description: The name used for billing purposes.
        type: string
      billingPhone:
        description: >-
          The phone number used for billing purposes. The recommended format is
          (800)555-1212.
        type: string
      billingPostalCode:
        description: The postal code used for billing purposes.
        type: string
      billingState:
        description: >-
          The name of the state used for billing purposes. This value may be any
          2 character state code or the full state name.
        type: string
      shippingAddress1:
        description: The street address used for shipping purposes.
        type: string
      shippingAddress2:
        description: The street address used for shipping purposes.
        type: string
      shippingCity:
        description: The name of the city used for shipping purposes.
        type: string
      shippingEmail:
        description: The e-mail address used for shipping purposes.
        type: string
      shippingName:
        description: The name used for shipping purposes.
        type: string
      shippingPhone:
        description: >-
          The phone number used for shipping purposes. The recommended format is
          (800)555-1212
        type: string
      shippingPostalCode:
        description: The postal code used for shipping purposes.
        type: string
      shippingState:
        description: >-
          The name of the state used for shipping purposes. This value may be
          any 2 character state code or the full state name.
        type: string
  POST_Address_v1_return_transactionId_paymentType:
    description: Address
    properties:
      billingAddress1:
        description: The street address used for billing purposes.
        type: string
      billingAddress2:
        description: The street address used for billing purposes.
        type: string
      billingCity:
        description: The name of the city used for billing purposes.
        type: string
      billingEmail:
        description: The e-mail address used for billing purposes.
        type: string
      billingName:
        description: The name used for billing purposes.
        type: string
      billingPhone:
        description: >-
          The phone number used for billing purposes. The recommended format is
          (800)555-1212.
        type: string
      billingPostalCode:
        description: The postal code used for billing purposes.
        type: string
      billingState:
        description: >-
          The name of the state used for billing purposes. This value may be any
          2 character state code or the full state name.
        type: string
      shippingAddress1:
        description: The street address used for shipping purposes.
        type: string
      shippingAddress2:
        description: The street address used for shipping purposes.
        type: string
      shippingCity:
        description: The name of the city used for shipping purposes.
        type: string
      shippingEmail:
        description: The e-mail address used for shipping purposes.
        type: string
      shippingName:
        description: The name used for shipping purposes.
        type: string
      shippingPhone:
        description: >-
          The phone number used for shipping purposes. The recommended format is
          (800)555-1212
        type: string
      shippingPostalCode:
        description: The postal code used for shipping purposes.
        type: string
      shippingState:
        description: >-
          The name of the state used for shipping purposes. This value may be
          any 2 character state code or the full state name.
        type: string
  POST_Address_v1_sale:
    description: Address
    properties:
      billingAddress1:
        description: The street address used for billing purposes.
        type: string
      billingAddress2:
        description: The street address used for billing purposes.
        type: string
      billingCity:
        description: The name of the city used for billing purposes.
        type: string
      billingEmail:
        description: The e-mail address used for billing purposes.
        type: string
      billingName:
        description: The name used for billing purposes.
        type: string
      billingPhone:
        description: >-
          The phone number used for billing purposes. The recommended format is
          (800)555-1212.
        type: string
      billingPostalCode:
        description: The postal code used for billing purposes.
        type: string
      billingState:
        description: >-
          The name of the state used for billing purposes. This value may be any
          2 character state code or the full state name.
        type: string
      shippingAddress1:
        description: The street address used for shipping purposes.
        type: string
      shippingAddress2:
        description: The street address used for shipping purposes.
        type: string
      shippingCity:
        description: The name of the city used for shipping purposes.
        type: string
      shippingEmail:
        description: The e-mail address used for shipping purposes.
        type: string
      shippingName:
        description: The name used for shipping purposes.
        type: string
      shippingPhone:
        description: >-
          The phone number used for shipping purposes. The recommended format is
          (800)555-1212
        type: string
      shippingPostalCode:
        description: The postal code used for shipping purposes.
        type: string
      shippingState:
        description: >-
          The name of the state used for shipping purposes. This value may be
          any 2 character state code or the full state name.
        type: string
  POST_Address_v1_sale_paymentAccountId:
    description: Address
    properties:
      billingAddress1:
        description: The street address used for billing purposes.
        type: string
      billingAddress2:
        description: The street address used for billing purposes.
        type: string
      billingCity:
        description: The name of the city used for billing purposes.
        type: string
      billingEmail:
        description: The e-mail address used for billing purposes.
        type: string
      billingName:
        description: The name used for billing purposes.
        type: string
      billingPhone:
        description: >-
          The phone number used for billing purposes. The recommended format is
          (800)555-1212.
        type: string
      billingPostalCode:
        description: The postal code used for billing purposes.
        type: string
      billingState:
        description: >-
          The name of the state used for billing purposes. This value may be any
          2 character state code or the full state name.
        type: string
      shippingAddress1:
        description: The street address used for shipping purposes.
        type: string
      shippingAddress2:
        description: The street address used for shipping purposes.
        type: string
      shippingCity:
        description: The name of the city used for shipping purposes.
        type: string
      shippingEmail:
        description: The e-mail address used for shipping purposes.
        type: string
      shippingName:
        description: The name used for shipping purposes.
        type: string
      shippingPhone:
        description: >-
          The phone number used for shipping purposes. The recommended format is
          (800)555-1212
        type: string
      shippingPostalCode:
        description: The postal code used for shipping purposes.
        type: string
      shippingState:
        description: >-
          The name of the state used for shipping purposes. This value may be
          any 2 character state code or the full state name.
        type: string
  POST_Address_v1_sale_token:
    description: Address
    properties:
      billingAddress1:
        description: The street address used for billing purposes.
        type: string
      billingAddress2:
        description: The street address used for billing purposes.
        type: string
      billingCity:
        description: The name of the city used for billing purposes.
        type: string
      billingEmail:
        description: The e-mail address used for billing purposes.
        type: string
      billingName:
        description: The name used for billing purposes.
        type: string
      billingPhone:
        description: >-
          The phone number used for billing purposes. The recommended format is
          (800)555-1212.
        type: string
      billingPostalCode:
        description: The postal code used for billing purposes.
        type: string
      billingState:
        description: >-
          The name of the state used for billing purposes. This value may be any
          2 character state code or the full state name.
        type: string
      shippingAddress1:
        description: The street address used for shipping purposes.
        type: string
      shippingAddress2:
        description: The street address used for shipping purposes.
        type: string
      shippingCity:
        description: The name of the city used for shipping purposes.
        type: string
      shippingEmail:
        description: The e-mail address used for shipping purposes.
        type: string
      shippingName:
        description: The name used for shipping purposes.
        type: string
      shippingPhone:
        description: >-
          The phone number used for shipping purposes. The recommended format is
          (800)555-1212
        type: string
      shippingPostalCode:
        description: The postal code used for shipping purposes.
        type: string
      shippingState:
        description: >-
          The name of the state used for shipping purposes. This value may be
          any 2 character state code or the full state name.
        type: string
  POST_Address_v1_sale_transactionId_return_paymentType:
    description: Address
    properties:
      billingAddress1:
        description: The street address used for billing purposes.
        type: string
      billingAddress2:
        description: The street address used for billing purposes.
        type: string
      billingCity:
        description: The name of the city used for billing purposes.
        type: string
      billingEmail:
        description: The e-mail address used for billing purposes.
        type: string
      billingName:
        description: The name used for billing purposes.
        type: string
      billingPhone:
        description: >-
          The phone number used for billing purposes. The recommended format is
          (800)555-1212.
        type: string
      billingPostalCode:
        description: The postal code used for billing purposes.
        type: string
      billingState:
        description: >-
          The name of the state used for billing purposes. This value may be any
          2 character state code or the full state name.
        type: string
      shippingAddress1:
        description: The street address used for shipping purposes.
        type: string
      shippingAddress2:
        description: The street address used for shipping purposes.
        type: string
      shippingCity:
        description: The name of the city used for shipping purposes.
        type: string
      shippingEmail:
        description: The e-mail address used for shipping purposes.
        type: string
      shippingName:
        description: The name used for shipping purposes.
        type: string
      shippingPhone:
        description: >-
          The phone number used for shipping purposes. The recommended format is
          (800)555-1212
        type: string
      shippingPostalCode:
        description: The postal code used for shipping purposes.
        type: string
      shippingState:
        description: >-
          The name of the state used for shipping purposes. This value may be
          any 2 character state code or the full state name.
        type: string
  POST_AuthorizationCompletionRequestConfiguration_v1_authorization_transactionId_completion:
    description: AuthorizationCompletionRequestConfiguration
    properties:
      allowPartialApprovals:
        description: 'If set to false, partial approvals are not allowed'
        type: boolean
      cardReadRetries:
        description: "Number of retries in case of bad card read. The\_default\_value\_is\_1."
        format: int32
        type: integer
      checkForDuplicateTransactions:
        description: >-
          If set to true, enables duplicate checking logic for the transaction
          at the host.
        type: boolean
      isManualEntryAllowed:
        description: >-
          Use this parameter to allow manual entry of card account numbers on
          the PIN pad.
        type: string
      marketCode:
        description: 'The market code of the transaction. '
        type: string
      promptForSignature:
        description: >-
          Specifies how the signature prompt should be handled for the request.
          If a value is not provided, Never will be used. See <a
          href='https://triposcert.vantiv.com/api/help/kb/signaturePrompt.html'>Signature Prompt</a>.
        type: string
      provisionalAmount:
        description: >-
          Override provisional amount used for QC transactions, which is $1.00
          by default
        type: string
      userInputTimeout:
        description: Specifies the user input timeout.
        type: string
  POST_AuthorizationCompletionRequest_v1_authorization_transactionId_completion:
    description: AuthorizationCompletionRequest
    properties:
      address:
        $ref: '#/definitions/POST_Address_v1_authorization_transactionId_completion'
        description: The cardholder address information for the transaction.
      autoRental:
        $ref: >-
          #/definitions/POST_AutoRental_v1_authorization_transactionId_completion
        description: >-
          The auto rental parameters to be passed in for an auto rental
          transaction. <a href='https://triposcert.vantiv.com/api/help/kb/autorental.html'>more&raquo;</a>
      cardHolderPresentCode:
        description: >-
          Defines whether the cardholder is present at the transaction. This
          value is optional, but recommended to be set. If this value is not set
          in the request, it will be automatically set based on the market code.
        type: string
      clerkNumber:
        description: An optional clerk number for reference.
        type: string
      commercialCardCustomerCode:
        description: >-
          The commercial card customer code for the transaction. This is for
          Level II.
        type: string
      configuration:
        $ref: >-
          #/definitions/POST_AuthorizationCompletionRequestConfiguration_v1_authorization_transactionId_completion
        description: >-
          Any value included in this section will override the corresponding
          value set in the triPOS.config
      convenienceFeeAmount:
        description: >-
          The convenience fee amount of the transaction. This amount is added to
          the TotalAmount before the cardholder is charged
        format: double
        type: number
      laneId:
        description: Specifies which lane to use.
        format: int32
        type: integer
      lodging:
        $ref: >-
          #/definitions/POST_LodgingTransactionCompletion_v1_authorization_transactionId_completion
        description: >-
          The lodging parameters to be passed in for a lodging transaction. <a
          href='https://triposcert.vantiv.com/api/help/kb/lodging.html'>more&raquo;</a>
      networkTransactionID:
        description: >-
          The card brand specific transaction ID that should be stored by the
          integrator.
        type: string
      recurringPaymentType:
        description: Intent of why the credentials are being stored.
        type: string
      referenceNumber:
        description: A user defined reference number.
        type: string
      salesTaxAmount:
        description: >-
          The amount of sales tax for the transaction. This is for Level II,
          submit amount for tax or 0.00 for tax-exempt.
        format: double
        type: number
      shiftId:
        description: An optional shift id for reference.
        type: string
      submissionType:
        description: Specifies the type of transaction.
        type: string
      ticketNumber:
        description: An optional ticket number.
        type: string
      tipAmount:
        description: >-
          The tip amount of the transaction. This amount is added to the
          TotalAmount before the cardholder is charged.
        format: double
        type: number
      transactionAmount:
        description: >-
          The total transaction amount. This is the amount of funds to move on
          the card
        format: double
        type: number
    required:
      - laneId
      - transactionAmount
  POST_AuthorizationRequestConfiguration_v1_authorization:
    description: AuthorizationRequestConfiguration
    properties:
      allowPartialApprovals:
        description: 'If set to false, partial approvals are not allowed'
        type: boolean
      cardReadRetries:
        description: "Number of retries in case of bad card read. The\_default\_value\_is\_1."
        format: int32
        type: integer
      checkForDuplicateTransactions:
        description: >-
          If set to true, enables duplicate checking logic for the transaction
          at the host.
        type: boolean
      isManualEntryAllowed:
        description: >-
          Use this parameter to allow manual entry of card account numbers on
          the PIN pad.
        type: string
      marketCode:
        description: 'The market code of the transaction. '
        type: string
      promptForSignature:
        description: >-
          Specifies how the signature prompt should be handled for the request.
          If a value is not provided, Never will be used. See <a
          href='https://triposcert.vantiv.com/api/help/kb/signaturePrompt.html'>Signature Prompt</a>.
        type: string
      provisionalAmount:
        description: >-
          Override provisional amount used for QC transactions, which is $1.00
          by default
        type: string
      userInputTimeout:
        description: Specifies the user input timeout.
        type: string
  POST_AuthorizationRequest_v1_authorization:
    description: AuthorizationRequest
    properties:
      address:
        $ref: '#/definitions/POST_Address_v1_authorization'
        description: The cardholder address information for the transaction.
      autoRental:
        $ref: '#/definitions/POST_AutoRentalBasic_v1_authorization'
        description: >-
          The auto rental parameters to be passed in for an auto rental
          transaction. <a href='https://triposcert.vantiv.com/api/help/kb/autorental.html'>more&raquo;</a>
      cardHolderPresentCode:
        description: >-
          Defines whether the cardholder is present at the transaction. This
          value is optional, but recommended to be set. If this value is not set
          in the request, it will be automatically set based on the market code.
        type: string
      checkForPreReadId:
        description: >-
          Flag to support 'PreReadId feature in quick chip' transaction request.
          This will take precedence over triPOS.config flag.
        type: boolean
      clerkNumber:
        description: An optional clerk number for reference.
        type: string
      commercialCardCustomerCode:
        description: >-
          The commercial card customer code for the transaction. This is for
          Level II.
        type: string
      configuration:
        $ref: '#/definitions/POST_AuthorizationRequestConfiguration_v1_authorization'
        description: >-
          Any value included in this section will override the corresponding
          value set in the triPOS.config
      convenienceFeeAmount:
        description: >-
          The convenience fee amount of the transaction. This amount is added to
          the TotalAmount before the cardholder is charged
        format: double
        type: number
      creditSurchargeAmount:
        description: >-
          The credit surcharge amount of the transaction. This amount is added
          to the TotalAmount before the cardholder is charged. <a
          href='https://triposcert.vantiv.com/api/help/kb/cloud/Surcharging.html'>more&raquo;</a>
        format: double
        type: number
      displayTransactionAmount:
        description: Display the transaction amount during card read.
        type: boolean
      estimatedAmountIndicator:
        description: >-
          The EstimatedAmountIndicator can be used by merchants/integrators to
          define the TransactionAmount submitted to Express either as an
          Estimated Amount (i.e. amount to charge cardholder may change) or a
          Final Amount (i.e. amount to charge cardholder will not change).  It
          will be a 1-character request field supporting the following request
          settings:
        type: string
      getToken:
        description: >-
          To retrieve Token in the transaction. <a
          href='https://triposcert.vantiv.com/api/help/kb/GetToken.html'>more&raquo;</a>
        type: string
      healthcare:
        $ref: '#/definitions/POST_Healthcare_v1_authorization'
        description: >-
          The healthcare section that contains all applicable
          healthcare-qualified amounts. <a
          href='https://triposcert.vantiv.com/api/help/kb/healthcare.html'>more&raquo;</a>
      invokeManualEntry:
        description: ' Invokes manual card entry.'
        type: boolean
      isCscSupported:
        description: >-
          Invokes prompt for cardholder to enter card security code for manual
          keyed card entry.
        type: string
      laneId:
        description: Specifies which lane to use.
        format: int32
        type: integer
      lodging:
        $ref: '#/definitions/POST_LodgingAuthorization_v1_authorization'
        description: >-
          The lodging parameters to be passed in for a lodging transaction. <a
          href='https://triposcert.vantiv.com/api/help/kb/lodging.html'>more&raquo;</a>
      networkTransactionID:
        description: >-
          The card brand specific transaction ID that should be stored by the
          integrator.
        type: string
      nonFinancialExpected:
        description: >-
          Non Financial Card read Expected. Only supported on unattended
          devices.
        type: boolean
      preRead:
        description: >-
          Flag indicating desire to process authorization as PreRead (i.e. - do
          ONLY Pre-Read operations, then expecting next endpoint call to be
          QuickChip) <a
          href='https://triposcert.vantiv.com/api/help/kb/cloud/QuickChipConfiguration.html'>more&raquo;</a>.
        type: boolean
      preReadId:
        $ref: '#/definitions/POST_Guid_v1_authorization'
        description: >-
          A unique ID for this request. This value should be a GUID.<a
          href='..\help\kb\QuickChipWithPreReadId.html'>more&raquo;</a>.
      quickChip:
        description: >-
          Flag indicating desire to process authorization as QuickChip (i.e. -
          Pre-Read has been previously performed) <a
          href='https://triposcert.vantiv.com/api/help/kb/cloud/QuickChipConfiguration.html'>more&raquo;</a>.
        type: boolean
      recurringPaymentType:
        description: 'Recurring PaymentType,Intent of why the credentials are being stored.'
        type: string
      referenceNumber:
        description: A user defined reference number.
        type: string
      salesTaxAmount:
        description: >-
          The amount of sales tax for the transaction. This is for Level II,
          submit amount for tax or 0.00 for tax-exempt.
        format: double
        type: number
      shiftId:
        description: An optional shift id for reference.
        type: string
      submissionType:
        description: 'SubmissionType,Initial vs Subsequent Transaction.'
        type: string
      ticketNumber:
        description: An optional ticket number.
        type: string
      tipAmount:
        description: >-
          The tip amount of the transaction. This amount is added to the
          TotalAmount before the cardholder is charged.
        format: double
        type: number
      transactionAmount:
        description: >-
          The total transaction amount. This is the amount of funds to move on
          the card
        type: string
    required:
      - laneId
      - transactionAmount
  POST_AutoRentalAdjustmentData_v1_authorization_transactionId_completion:
    description: AutoRentalAdjustmentData
    properties:
      amount:
        description: Adjustment amount.
        format: double
        type: number
      code:
        description: >-
          Indicates if adjustment for mileage, fuel, vehicle damage, etc. was
          made to a rental agreement.
        type: string
      extraChargesDetail:
        description: >-
          Pass in up to 6 values that describe the extra charges. For an empty
          or invalid value, this parameter defaults to NoExtraCharge.
        items:
          enum:
            - NoExtraCharge
            - Gasoline
            - ExtraMileage
            - LateReturn
            - OneWayServiceFee
            - ParkingOrMovingViolation
          type: string
        type: array
  POST_AutoRentalAdjustmentData_v1_force_credit:
    description: AutoRentalAdjustmentData
    properties:
      amount:
        description: Adjustment amount.
        format: double
        type: number
      code:
        description: >-
          Indicates if adjustment for mileage, fuel, vehicle damage, etc. was
          made to a rental agreement.
        type: string
      extraChargesDetail:
        description: >-
          Pass in up to 6 values that describe the extra charges. For an empty
          or invalid value, this parameter defaults to NoExtraCharge.
        items:
          enum:
            - NoExtraCharge
            - Gasoline
            - ExtraMileage
            - LateReturn
            - OneWayServiceFee
            - ParkingOrMovingViolation
          type: string
        type: array
  POST_AutoRentalAdjustmentData_v1_sale:
    description: AutoRentalAdjustmentData
    properties:
      amount:
        description: Adjustment amount.
        format: double
        type: number
      code:
        description: >-
          Indicates if adjustment for mileage, fuel, vehicle damage, etc. was
          made to a rental agreement.
        type: string
      extraChargesDetail:
        description: >-
          Pass in up to 6 values that describe the extra charges. For an empty
          or invalid value, this parameter defaults to NoExtraCharge.
        items:
          enum:
            - NoExtraCharge
            - Gasoline
            - ExtraMileage
            - LateReturn
            - OneWayServiceFee
            - ParkingOrMovingViolation
          type: string
        type: array
  POST_AutoRentalAdjustmentData_v1_sale_token:
    description: AutoRentalAdjustmentData
    properties:
      amount:
        description: Adjustment amount.
        format: double
        type: number
      code:
        description: >-
          Indicates if adjustment for mileage, fuel, vehicle damage, etc. was
          made to a rental agreement.
        type: string
      extraChargesDetail:
        description: >-
          Pass in up to 6 values that describe the extra charges. For an empty
          or invalid value, this parameter defaults to NoExtraCharge.
        items:
          enum:
            - NoExtraCharge
            - Gasoline
            - ExtraMileage
            - LateReturn
            - OneWayServiceFee
            - ParkingOrMovingViolation
          type: string
        type: array
  POST_AutoRentalBasic_v1_authorization:
    description: AutoRentalBasic
    properties:
      duration:
        description: >-
          The number of rental days. Value should be between 0 and 99. Set to 01
          for no show rentals.
        format: int32
        type: integer
  POST_AutoRentalBasic_v1_authorization_token:
    description: AutoRentalBasic
    properties:
      duration:
        description: >-
          The number of rental days. Value should be between 0 and 99. Set to 01
          for no show rentals.
        format: int32
        type: integer
  POST_AutoRentalBasic_v1_authorization_transactionId_incremental:
    description: AutoRentalBasic
    properties:
      duration:
        description: >-
          The number of rental days. Value should be between 0 and 99. Set to 01
          for no show rentals.
        format: int32
        type: integer
  POST_AutoRentalBasic_v1_credit:
    description: AutoRentalBasic
    properties:
      duration:
        description: >-
          The number of rental days. Value should be between 0 and 99. Set to 01
          for no show rentals.
        format: int32
        type: integer
  POST_AutoRentalBasic_v1_refund:
    description: AutoRentalBasic
    properties:
      duration:
        description: >-
          The number of rental days. Value should be between 0 and 99. Set to 01
          for no show rentals.
        format: int32
        type: integer
  POST_AutoRentalBasic_v1_return_transactionId_paymentType:
    description: AutoRentalBasic
    properties:
      duration:
        description: >-
          The number of rental days. Value should be between 0 and 99. Set to 01
          for no show rentals.
        format: int32
        type: integer
  POST_AutoRentalBasic_v1_sale_transactionId_return_paymentType:
    description: AutoRentalBasic
    properties:
      duration:
        description: >-
          The number of rental days. Value should be between 0 and 99. Set to 01
          for no show rentals.
        format: int32
        type: integer
  POST_AutoRentalPickupData_v1_authorization_transactionId_completion:
    description: AutoRentalPickupData
    properties:
      city:
        description: Auto rental pickup city.
        type: string
      countryCode:
        description: 'Country code where vehicle was picked up. For US, use 840.'
        type: string
      date:
        description: 'return date in yyyy-MM-ddTHH:mm:ss format.'
        type: string
      location:
        description: Name of business where vehicle was picked up.
        type: string
      state:
        description: >-
          Abbreviation of state, province, or other country subdivision where
          vehicle was picked up.
        type: string
  POST_AutoRentalPickupData_v1_force_credit:
    description: AutoRentalPickupData
    properties:
      city:
        description: Auto rental pickup city.
        type: string
      countryCode:
        description: 'Country code where vehicle was picked up. For US, use 840.'
        type: string
      date:
        description: 'return date in yyyy-MM-ddTHH:mm:ss format.'
        type: string
      location:
        description: Name of business where vehicle was picked up.
        type: string
      state:
        description: >-
          Abbreviation of state, province, or other country subdivision where
          vehicle was picked up.
        type: string
  POST_AutoRentalPickupData_v1_sale:
    description: AutoRentalPickupData
    properties:
      city:
        description: Auto rental pickup city.
        type: string
      countryCode:
        description: 'Country code where vehicle was picked up. For US, use 840.'
        type: string
      date:
        description: 'return date in yyyy-MM-ddTHH:mm:ss format.'
        type: string
      location:
        description: Name of business where vehicle was picked up.
        type: string
      state:
        description: >-
          Abbreviation of state, province, or other country subdivision where
          vehicle was picked up.
        type: string
  POST_AutoRentalPickupData_v1_sale_token:
    description: AutoRentalPickupData
    properties:
      city:
        description: Auto rental pickup city.
        type: string
      countryCode:
        description: 'Country code where vehicle was picked up. For US, use 840.'
        type: string
      date:
        description: 'return date in yyyy-MM-ddTHH:mm:ss format.'
        type: string
      location:
        description: Name of business where vehicle was picked up.
        type: string
      state:
        description: >-
          Abbreviation of state, province, or other country subdivision where
          vehicle was picked up.
        type: string
  POST_AutoRentalReturnData_v1_authorization_transactionId_completion:
    description: AutoRentalReturnData
    properties:
      city:
        description: Auto rental return city.
        type: string
      countryCode:
        description: 'Country code where vehicle was returned. For US, use 840.'
        type: string
      date:
        description: 'return date in yyyy-MM-ddTHH:mm:ss format.'
        type: string
      distance:
        description: Numeric distance traveled during rental period.
        format: int32
        type: integer
      distanceUnit:
        description: Unit of measurement applicable to distance traveled.
        type: string
      locationId:
        description: Auto Rental location ID where vehicle was returned.
        type: string
      state:
        description: Auto rental return state.
        type: string
  POST_AutoRentalReturnData_v1_force_credit:
    description: AutoRentalReturnData
    properties:
      city:
        description: Auto rental return city.
        type: string
      countryCode:
        description: 'Country code where vehicle was returned. For US, use 840.'
        type: string
      date:
        description: 'return date in yyyy-MM-ddTHH:mm:ss format.'
        type: string
      distance:
        description: Numeric distance traveled during rental period.
        format: int32
        type: integer
      distanceUnit:
        description: Unit of measurement applicable to distance traveled.
        type: string
      locationId:
        description: Auto Rental location ID where vehicle was returned.
        type: string
      state:
        description: Auto rental return state.
        type: string
  POST_AutoRentalReturnData_v1_sale:
    description: AutoRentalReturnData
    properties:
      city:
        description: Auto rental return city.
        type: string
      countryCode:
        description: 'Country code where vehicle was returned. For US, use 840.'
        type: string
      date:
        description: 'return date in yyyy-MM-ddTHH:mm:ss format.'
        type: string
      distance:
        description: Numeric distance traveled during rental period.
        format: int32
        type: integer
      distanceUnit:
        description: Unit of measurement applicable to distance traveled.
        type: string
      locationId:
        description: Auto Rental location ID where vehicle was returned.
        type: string
      state:
        description: Auto rental return state.
        type: string
  POST_AutoRentalReturnData_v1_sale_token:
    description: AutoRentalReturnData
    properties:
      city:
        description: Auto rental return city.
        type: string
      countryCode:
        description: 'Country code where vehicle was returned. For US, use 840.'
        type: string
      date:
        description: 'return date in yyyy-MM-ddTHH:mm:ss format.'
        type: string
      distance:
        description: Numeric distance traveled during rental period.
        format: int32
        type: integer
      distanceUnit:
        description: Unit of measurement applicable to distance traveled.
        type: string
      locationId:
        description: Auto Rental location ID where vehicle was returned.
        type: string
      state:
        description: Auto rental return state.
        type: string
  POST_AutoRental_v1_authorization_transactionId_completion:
    description: AutoRental
    properties:
      adjustmentData:
        $ref: >-
          #/definitions/POST_AutoRentalAdjustmentData_v1_authorization_transactionId_completion
        description: Data related to any auto rental adjustments.
      agreementNumber:
        description: Agreement number.
        type: string
      customerName:
        description: Customer Name.
        type: string
      dailyRentalRate:
        description: >-
          Rate charged per day Visa/MC – Daily rate required for Corp T&E rate
          III.
        format: double
        type: number
      duration:
        description: >-
          The number of rental days. Value should be between 0 and 99. Set to 01
          for no show rentals.
        format: int32
        type: integer
      insuranceCharges:
        description: 'If insurance is charged, the insurance amount should be provided.'
        format: double
        type: number
      noShowIndicator:
        description: >-
          No show indicator. Indicates whether rental vehicle was reserved, but
          not actually rented.
        type: string
      pickupData:
        $ref: >-
          #/definitions/POST_AutoRentalPickupData_v1_authorization_transactionId_completion
        description: Data related to autorental pickup.
      returnData:
        $ref: >-
          #/definitions/POST_AutoRentalReturnData_v1_authorization_transactionId_completion
        description: Data related to autorental return.
      vehicleClassCode:
        description: Classification of rental vehicle
        type: string
      weeklyRentalRate:
        description: >-
          Rate charged per week Visa/MC – Weekly rate required for Corp T&E rate
          III.
        format: double
        type: number
  POST_AutoRental_v1_force_credit:
    description: AutoRental
    properties:
      adjustmentData:
        $ref: '#/definitions/POST_AutoRentalAdjustmentData_v1_force_credit'
        description: Data related to any auto rental adjustments.
      agreementNumber:
        description: Agreement number.
        type: string
      customerName:
        description: Customer Name.
        type: string
      dailyRentalRate:
        description: >-
          Rate charged per day Visa/MC – Daily rate required for Corp T&E rate
          III.
        format: double
        type: number
      duration:
        description: >-
          The number of rental days. Value should be between 0 and 99. Set to 01
          for no show rentals.
        format: int32
        type: integer
      insuranceCharges:
        description: 'If insurance is charged, the insurance amount should be provided.'
        format: double
        type: number
      noShowIndicator:
        description: >-
          No show indicator. Indicates whether rental vehicle was reserved, but
          not actually rented.
        type: string
      pickupData:
        $ref: '#/definitions/POST_AutoRentalPickupData_v1_force_credit'
        description: Data related to autorental pickup.
      returnData:
        $ref: '#/definitions/POST_AutoRentalReturnData_v1_force_credit'
        description: Data related to autorental return.
      vehicleClassCode:
        description: Classification of rental vehicle
        type: string
      weeklyRentalRate:
        description: >-
          Rate charged per week Visa/MC – Weekly rate required for Corp T&E rate
          III.
        format: double
        type: number
  POST_AutoRental_v1_sale:
    description: AutoRental
    properties:
      adjustmentData:
        $ref: '#/definitions/POST_AutoRentalAdjustmentData_v1_sale'
        description: Data related to any auto rental adjustments.
      agreementNumber:
        description: Agreement number.
        type: string
      customerName:
        description: Customer Name.
        type: string
      dailyRentalRate:
        description: >-
          Rate charged per day Visa/MC – Daily rate required for Corp T&E rate
          III.
        format: double
        type: number
      duration:
        description: >-
          The number of rental days. Value should be between 0 and 99. Set to 01
          for no show rentals.
        format: int32
        type: integer
      insuranceCharges:
        description: 'If insurance is charged, the insurance amount should be provided.'
        format: double
        type: number
      noShowIndicator:
        description: >-
          No show indicator. Indicates whether rental vehicle was reserved, but
          not actually rented.
        type: string
      pickupData:
        $ref: '#/definitions/POST_AutoRentalPickupData_v1_sale'
        description: Data related to autorental pickup.
      returnData:
        $ref: '#/definitions/POST_AutoRentalReturnData_v1_sale'
        description: Data related to autorental return.
      vehicleClassCode:
        description: Classification of rental vehicle
        type: string
      weeklyRentalRate:
        description: >-
          Rate charged per week Visa/MC – Weekly rate required for Corp T&E rate
          III.
        format: double
        type: number
  POST_AutoRental_v1_sale_token:
    description: AutoRental
    properties:
      adjustmentData:
        $ref: '#/definitions/POST_AutoRentalAdjustmentData_v1_sale_token'
        description: Data related to any auto rental adjustments.
      agreementNumber:
        description: Agreement number.
        type: string
      customerName:
        description: Customer Name.
        type: string
      dailyRentalRate:
        description: >-
          Rate charged per day Visa/MC – Daily rate required for Corp T&E rate
          III.
        format: double
        type: number
      duration:
        description: >-
          The number of rental days. Value should be between 0 and 99. Set to 01
          for no show rentals.
        format: int32
        type: integer
      insuranceCharges:
        description: 'If insurance is charged, the insurance amount should be provided.'
        format: double
        type: number
      noShowIndicator:
        description: >-
          No show indicator. Indicates whether rental vehicle was reserved, but
          not actually rented.
        type: string
      pickupData:
        $ref: '#/definitions/POST_AutoRentalPickupData_v1_sale_token'
        description: Data related to autorental pickup.
      returnData:
        $ref: '#/definitions/POST_AutoRentalReturnData_v1_sale_token'
        description: Data related to autorental return.
      vehicleClassCode:
        description: Classification of rental vehicle
        type: string
      weeklyRentalRate:
        description: >-
          Rate charged per week Visa/MC – Weekly rate required for Corp T&E rate
          III.
        format: double
        type: number
  POST_BalanceRequest_v1_balance:
    description: BalanceRequest
    properties:
      cardHolderPresentCode:
        description: >-
          Defines whether the cardholder is present at the transaction. This
          value is optional, but recommended to be set. If this value is not set
          in the request, it will be automatically set based on the market code.
        type: string
      clerkNumber:
        description: An optional clerk number for reference.
        type: string
      configuration:
        $ref: '#/definitions/POST_RequestConfiguration_v1_balance'
        description: >-
          Any value included in this section will override the corresponding
          value set in the triPOS.config
      ebtType:
        description: EbtType may be FoodStamp or CashBenefit
        type: string
      giftCardProgram:
        description: >-
          This field is for Valutec gift/loyalty card program. <br>'01' =
          Original Gift Card Program <br>'02' = Promotional Gift Card Program
          <br>'03' = Original Combo Card Program <br>'04' = Auto Rewards LPR
          Card Program <br>'05' = Original Loyalty Card Program
        type: string
      giftProgramType:
        description: >-
          This field is for Valutec gift/loyalty card type. The value 0 is for
          gift and 1 for loyalty
        type: string
      invokeManualEntry:
        description: Invokes manual card entry.
        type: boolean
      isCscSupported:
        description: >-
          Invokes prompt for cardholder to enter card security code for manual
          keyed card entry.
        type: string
      isGiftSupported:
        description: Allows to use gift card functionality
        type: string
      laneId:
        description: Specifies which lane to use.
        format: int32
        type: integer
      referenceNumber:
        description: A user defined reference number.
        type: string
      shiftId:
        description: An optional shift id for reference.
        type: string
      storeCard:
        $ref: '#/definitions/POST_StoreCard_v1_balance'
        description: Information necessary to process a StoreCard transaction.
      ticketNumber:
        description: An optional ticket number.
        type: string
    required:
      - laneId
  POST_BalanceTransferGiftRequest_v1_gift_balanceTransfer:
    description: BalanceTransferGiftRequest
    properties:
      alternateCardNumber1:
        description: Gift card number to transfer
        type: string
      alternateCardNumber2:
        description: Second gift card number to transfer
        type: string
      alternateCardNumber3:
        description: Third gift card number to transfer
        type: string
      cardHolderPresentCode:
        description: >-
          Defines whether the cardholder is present at the transaction. This
          value is optional, but recommended to be set. If this value is not set
          in the request, it will be automatically set based on the market code.
        type: string
      clerkNumber:
        description: An optional clerk number for reference.
        type: string
      configuration:
        $ref: '#/definitions/POST_RequestConfiguration_v1_gift_balanceTransfer'
        description: >-
          Any value included in this section will override the corresponding
          value set in the triPOS.config
      giftCardProgram:
        description: >-
          This field is for Valutec gift/loyalty card program. <br>'01' =
          Original Gift Card Program <br>'02' = Promotional Gift Card Program
          <br>'03' = Original Combo Card Program <br>'04' = Auto Rewards LPR
          Card Program <br>'05' = Original Loyalty Card Program
        type: string
      giftProgramType:
        description: >-
          This field is for Valutec gift/loyalty card type. The value 0 is for
          gift and 1 for loyalty
        type: string
      invokeManualEntry:
        description: ' Invokes manual card entry.'
        type: boolean
      isCscSupported:
        description: >-
          Invokes prompt for cardholder to enter card security code for manual
          keyed card entry.
        type: string
      laneId:
        description: Specifies which lane to use.
        format: int32
        type: integer
      referenceNumber:
        description: A user defined reference number.
        type: string
      shiftId:
        description: An optional shift id for reference.
        type: string
      storeCard:
        $ref: '#/definitions/POST_StoreCard_v1_gift_balanceTransfer'
        description: Information necessary to process a StoreCard transaction.
      ticketNumber:
        description: An optional ticket number.
        type: string
      transactionAmount:
        description: >-
          The total transaction amount. This is the amount of funds to move on
          the card
        format: double
        type: number
    required:
      - alternateCardNumber1
      - laneId
      - transactionAmount
  POST_CancelTransactionRequest_v1_cancel:
    description: CancelTransactionRequest
    properties:
      laneId:
        description: The desired lane ID.
        format: int32
        type: integer
    required:
      - laneId
  POST_CashbackManualEntry_v1_sale:
    description: CashbackManualEntry
    properties:
      amountIncrement:
        description: >-
          The PIN pad will only accept a cashback amount in the provided
          increment (i.e. Set to 5 to only allow cashback amounts in increments
          of $5.00).
        format: int32
        type: integer
      maximumAmount:
        description: >-
          The PIN pad will only accept a cashback amount that does not exceed
          the provided maximum.
        format: int32
        type: integer
  POST_CashbackOptions_v1_sale:
    description: CashbackOptions
    properties:
      manualEntry:
        $ref: '#/definitions/POST_CashbackManualEntry_v1_sale'
        description: >-
          Configurable settings for allowing a cashback choice through manual
          entry.
      selectionAmounts:
        description: >-
          The cashback amounts to display on the PIN pad's selection buttons
          (i.e. 5,10,20,50).
        type: string
  POST_CloseGiftRequest_v1_gift_close:
    description: CloseGiftRequest
    properties:
      cardHolderPresentCode:
        description: >-
          Defines whether the cardholder is present at the transaction. This
          value is optional, but recommended to be set. If this value is not set
          in the request, it will be automatically set based on the market code.
        type: string
      clerkNumber:
        description: An optional clerk number for reference.
        type: string
      configuration:
        $ref: '#/definitions/POST_RequestConfiguration_v1_gift_close'
        description: >-
          Any value included in this section will override the corresponding
          value set in the triPOS.config
      giftCardProgram:
        description: >-
          This field is for Valutec gift/loyalty card program. <br>'01' =
          Original Gift Card Program <br>'02' = Promotional Gift Card Program
          <br>'03' = Original Combo Card Program <br>'04' = Auto Rewards LPR
          Card Program <br>'05' = Original Loyalty Card Program
        type: string
      giftProgramType:
        description: >-
          This field is for Valutec gift/loyalty card type. The value 0 is for
          gift and 1 for loyalty
        type: string
      invokeManualEntry:
        description: ' Invokes manual card entry.'
        type: boolean
      isCscSupported:
        description: >-
          Invokes prompt for cardholder to enter card security code for manual
          keyed card entry.
        type: string
      laneId:
        description: Specifies which lane to use.
        format: int32
        type: integer
      referenceNumber:
        description: A user defined reference number.
        type: string
      shiftId:
        description: An optional shift id for reference.
        type: string
      storeCard:
        $ref: '#/definitions/POST_StoreCard_v1_gift_close'
        description: Information necessary to process a StoreCard transaction.
      ticketNumber:
        description: An optional ticket number.
        type: string
      transactionAmount:
        description: >-
          The total transaction amount. This is the amount of funds to move on
          the card
        format: double
        type: number
    required:
      - laneId
      - transactionAmount
  POST_CreateOmniTokenRequest_v1_token_omni:
    description: CreateOmniTokenRequest
    properties:
      configuration:
        $ref: '#/definitions/POST_TokenRequestConfiguration_v1_token_omni'
        description: >-
          Any value included in this section will override the corresponding
          value set in the triPOS.config
      invokeManualEntry:
        description: Invokes manual card entry.
        type: boolean
      isCscSupported:
        description: >-
          Invokes prompt for cardholder to enter card security code for manual
          keyed card entry.
        type: string
      laneId:
        description: Specifies which lane to use.
        format: int32
        type: integer
      vaultId:
        description: The Vault ID with Omni.
        type: string
    required:
      - laneId
  POST_CreateOmniTokenWithTransIdRequest_v1_token_omni_transactionId:
    description: CreateOmniTokenWithTransIdRequest
    properties:
      laneId:
        description: The lane ID.
        format: int32
        type: integer
      vaultId:
        description: The Vault ID with Omni.
        type: string
    required:
      - laneId
  POST_CreatePaymentAccountCreditRequest_v1_paymentAccount:
    description: CreatePaymentAccountCreditRequest
    properties:
      address:
        $ref: '#/definitions/POST_Address_v1_paymentAccount'
        description: The cardholder address information for the transaction.
      configuration:
        $ref: '#/definitions/POST_TokenRequestConfiguration_v1_paymentAccount'
        description: >-
          Any value included in this section will override the corresponding
          value set in the triPOS.config
      expirationMonth:
        description: The expiration month.
        type: string
      expirationYear:
        description: The expiration year.
        type: string
      invokeManualEntry:
        description: ' Invokes manual card entry.'
        type: boolean
      isCscSupported:
        description: >-
          Invokes prompt for cardholder to enter card security code for manual
          keyed card entry.
        type: string
      laneId:
        description: The lane ID.
        format: int32
        type: integer
      paymentAccountReferenceNumber:
        description: The payment account reference number
        type: string
    required:
      - laneId
      - paymentAccountReferenceNumber
  POST_CreatePaymentAccountCreditRequest_v1_paymentAccount_credit:
    description: CreatePaymentAccountCreditRequest
    properties:
      address:
        $ref: '#/definitions/POST_Address_v1_paymentAccount_credit'
        description: The cardholder address information for the transaction.
      configuration:
        $ref: '#/definitions/POST_TokenRequestConfiguration_v1_paymentAccount_credit'
        description: >-
          Any value included in this section will override the corresponding
          value set in the triPOS.config
      expirationMonth:
        description: The expiration month.
        type: string
      expirationYear:
        description: The expiration year.
        type: string
      invokeManualEntry:
        description: ' Invokes manual card entry.'
        type: boolean
      isCscSupported:
        description: >-
          Invokes prompt for cardholder to enter card security code for manual
          keyed card entry.
        type: string
      laneId:
        description: The lane ID.
        format: int32
        type: integer
      paymentAccountReferenceNumber:
        description: The payment account reference number
        type: string
    required:
      - laneId
      - paymentAccountReferenceNumber
  POST_CreatePaymetricTokenRequest_v1_token_paymetric:
    description: CreatePaymetricTokenRequest
    properties:
      configuration:
        $ref: '#/definitions/POST_TokenRequestConfiguration_v1_token_paymetric'
        description: >-
          Any value included in this section will override the corresponding
          value set in the triPOS.config
      invokeManualEntry:
        description: ' Invokes manual card entry.'
        type: boolean
      isCscSupported:
        description: >-
          Invokes prompt for cardholder to enter card security code for manual
          keyed card entry.
        type: string
      laneId:
        description: Specifies which lane to use.
        format: int32
        type: integer
      vaultId:
        description: The Vault ID with Paymetric.
        type: string
    required:
      - laneId
      - vaultId
  POST_CreatePaymetricTokenWithTransIdRequest_v1_token_paymetric_transactionId:
    description: CreatePaymetricTokenWithTransIdRequest
    properties:
      laneId:
        description: The lane ID.
        format: int32
        type: integer
      vaultId:
        description: The Vault ID with Paymetric.
        type: string
    required:
      - laneId
      - vaultId
  POST_CreateWorldpayTokenRequest_v1_token_worldpay:
    description: CreateWorldpayTokenRequest
    properties:
      configuration:
        $ref: '#/definitions/POST_TokenRequestConfiguration_v1_token_worldpay'
        description: >-
          Any value included in this section will override the corresponding
          value set in the triPOS.config
      invokeManualEntry:
        description: Invokes manual card entry.
        type: boolean
      laneId:
        description: Specifies which lane to use.
        format: int32
        type: integer
      schemeReference:
        description: schemeReference of token to be created
        type: string
      type:
        description: >-
          Type of token to be created. Eg: cardOnFile, unscheduled,
          subscription, installment
        type: string
      usage:
        description: 'Usage of token to be created. Eg: first, subsequent, resubmission'
        type: string
    required:
      - laneId
      - type
      - usage
  POST_DisplayRequest_v1_display:
    description: DisplayRequest
    properties:
      laneId:
        description: The lane ID.
        format: int32
        type: integer
      text:
        description: >-
          The full text to display on the PIN pad. triPOS may split the text
          into multiple lines based on the size of the PIN pad's screen. Please
          test the text with the desired PIN pad to make sure it is displayed as
          expected. <a href='https://triposcert.vantiv.com/api/help/kb/display.html'>more&raquo;</a>
        type: string
    required:
      - laneId
  POST_EbtVoucherRequestConfiguration_v1_ebtVoucher:
    description: EbtVoucherRequestConfiguration
    properties:
      checkForDuplicateTransactions:
        description: >-
          If set to true, enables duplicate checking logic for the transaction
          at the host.
        type: boolean
      marketCode:
        description: 'The market code of the transaction. '
        type: string
  POST_EbtVoucherRequest_v1_ebtVoucher:
    description: EbtVoucherRequest
    properties:
      approvalNumber:
        description: The approval number of a voice authorization
        type: string
      cardHolderPresentCode:
        description: >-
          Defines whether the cardholder is present at the transaction. This
          value is optional, but recommended to be set. If this value is not set
          in the request, it will be automatically set based on the market code.
        type: string
      clerkNumber:
        description: An optional clerk number for reference.
        type: string
      configuration:
        $ref: '#/definitions/POST_EbtVoucherRequestConfiguration_v1_ebtVoucher'
        description: >-
          Any value included in this section will override the corresponding
          value set in the triPOS.config
      isCscSupported:
        description: >-
          Invokes prompt for cardholder to enter card security code for manual
          keyed card entry.
        type: string
      laneId:
        description: Specifies which lane to use.
        format: int32
        type: integer
      referenceNumber:
        description: A user defined reference number.
        type: string
      ticketNumber:
        description: An optional ticket number.
        type: string
      transactionAmount:
        description: >-
          The total transaction amount. This is the amount of funds to move on
          the card.
        format: double
        type: number
      voucherNumber:
        description: The voucher number to complete a foodstamp purchase.
        type: string
    required:
      - approvalNumber
      - laneId
      - transactionAmount
      - voucherNumber
  POST_EmvTagKeyValue_v1_receipt:
    description: EmvTagKeyValue
    properties:
      key:
        type: string
      value:
        type: string
  POST_FleetLineItemDetail_v1_credit:
    description: FleetLineItemDetail
    properties:
      lineItem:
        description: lineItem that required Level III LineItem fields to be submitted.
        items:
          $ref: '#/definitions/POST_FleetLineItem_v1_credit'
        type: array
    required:
      - lineItem
  POST_FleetLineItemDetail_v1_refund:
    description: FleetLineItemDetail
    properties:
      lineItem:
        description: lineItem that required Level III LineItem fields to be submitted.
        items:
          $ref: '#/definitions/POST_FleetLineItem_v1_refund'
        type: array
    required:
      - lineItem
  POST_FleetLineItemDetail_v1_return_transactionId_paymentType:
    description: FleetLineItemDetail
    properties:
      lineItem:
        description: lineItem that required Level III LineItem fields to be submitted.
        items:
          $ref: '#/definitions/POST_FleetLineItem_v1_return_transactionId_paymentType'
        type: array
    required:
      - lineItem
  POST_FleetLineItemDetail_v1_sale:
    description: FleetLineItemDetail
    properties:
      lineItem:
        description: lineItem that required Level III LineItem fields to be submitted.
        items:
          $ref: '#/definitions/POST_FleetLineItem_v1_sale'
        type: array
    required:
      - lineItem
  POST_FleetLineItemDetail_v1_sale_transactionId_return_paymentType:
    description: FleetLineItemDetail
    properties:
      lineItem:
        description: lineItem that required Level III LineItem fields to be submitted.
        items:
          $ref: >-
            #/definitions/POST_FleetLineItem_v1_sale_transactionId_return_paymentType
        type: array
    required:
      - lineItem
  POST_FleetLineItem_v1_credit:
    description: FleetLineItem
    properties:
      alternateTaxIdentifier:
        description: >-
          Tax identification number of the merchant reporting the alternate tax
          amount.  Not applicable for US merchants. (tag must be present, but
          can be empty)
        type: string
      debitCreditCode:
        description: >-
          Indicates whether extendedItemAmount is a Credit (taking away from the
          total amount of the sale) or Debit (adding to the total amount of the
          sale).  Recommend 0
        type: string
      discountCode:
        description: >-
          Indicates whether discount was applied to the purchase price of the
          item.  Recommend 0.
        type: string
      extendedItemAmount:
        description: >-
          Amount of the item (unit price multiplied by quantity only). 
          DDDDDDDDD.CC
        type: string
      itemCommodityCode:
        description: >-
          International description code of the individual good or service being
          supplied.  Recommend using numeric NACS code.
        type: string
      itemDescription:
        description: Item Description.
        type: string
      itemDiscountRate:
        description: >-
          Discount rate for the line item.  Submitted as a percentage. 
          Two-digit implied string.  Recommend 0.  For example, if 10.42%,
          submit 1042
        type: string
      lineItemDiscountAmount:
        description: >-
          Discount amount applied to the line item.  This field should be 0.00
          if the unit cost reflects a discount price or if no line item discount
          applies.  DDDDDDDDD.CC
        format: double
        type: number
      lineItemTotalAmount:
        description: >-
          Total full amount associated with the line item (UnitCost * Quantity)
          - LineItemDiscountAmount for that item. DDDDDDDDD.CC
        format: double
        type: number
      lineItemVatAmount:
        description: >-
          Amount of any sales or value added taxes associated with the item. 
          Recommend 0.00.  DDDDDDDDD.CC
        type: string
      lineItemVatRate:
        description: >-
          Tax rate used to calculate LineItemVATAmount.  Submitted as a
          percentage.  Two-digit implied string.  Recommend 0.  For example, if
          10.42%, submit 1042
        type: string
      netGrossCode:
        description: Indicates whether extended item amount included the tax.  Recommend 0.
        type: string
      productCode:
        description: Numeric NACS code.
        type: string
      quantity:
        description: Quantity of the item.  NNNNN.DDD
        format: double
        type: number
      unitCost:
        description: Unit cost of the item.  DDDDD.CC
        format: double
        type: number
      unitOfMeasure:
        description: Code for units of measurement.
        type: string
      vatType:
        description: >-
          Type of value added taxes being used. Not applicable for US merchants.
          (tag must be present, but can be empty)
        type: string
    required:
      - debitCreditCode
      - discountCode
      - extendedItemAmount
      - itemCommodityCode
      - itemDescription
      - itemDiscountRate
      - lineItemDiscountAmount
      - lineItemTotalAmount
      - lineItemVatAmount
      - lineItemVatRate
      - netGrossCode
      - productCode
      - quantity
      - unitCost
      - unitOfMeasure
  POST_FleetLineItem_v1_refund:
    description: FleetLineItem
    properties:
      alternateTaxIdentifier:
        description: >-
          Tax identification number of the merchant reporting the alternate tax
          amount.  Not applicable for US merchants. (tag must be present, but
          can be empty)
        type: string
      debitCreditCode:
        description: >-
          Indicates whether extendedItemAmount is a Credit (taking away from the
          total amount of the sale) or Debit (adding to the total amount of the
          sale).  Recommend 0
        type: string
      discountCode:
        description: >-
          Indicates whether discount was applied to the purchase price of the
          item.  Recommend 0.
        type: string
      extendedItemAmount:
        description: >-
          Amount of the item (unit price multiplied by quantity only). 
          DDDDDDDDD.CC
        type: string
      itemCommodityCode:
        description: >-
          International description code of the individual good or service being
          supplied.  Recommend using numeric NACS code.
        type: string
      itemDescription:
        description: Item Description.
        type: string
      itemDiscountRate:
        description: >-
          Discount rate for the line item.  Submitted as a percentage. 
          Two-digit implied string.  Recommend 0.  For example, if 10.42%,
          submit 1042
        type: string
      lineItemDiscountAmount:
        description: >-
          Discount amount applied to the line item.  This field should be 0.00
          if the unit cost reflects a discount price or if no line item discount
          applies.  DDDDDDDDD.CC
        format: double
        type: number
      lineItemTotalAmount:
        description: >-
          Total full amount associated with the line item (UnitCost * Quantity)
          - LineItemDiscountAmount for that item. DDDDDDDDD.CC
        format: double
        type: number
      lineItemVatAmount:
        description: >-
          Amount of any sales or value added taxes associated with the item. 
          Recommend 0.00.  DDDDDDDDD.CC
        type: string
      lineItemVatRate:
        description: >-
          Tax rate used to calculate LineItemVATAmount.  Submitted as a
          percentage.  Two-digit implied string.  Recommend 0.  For example, if
          10.42%, submit 1042
        type: string
      netGrossCode:
        description: Indicates whether extended item amount included the tax.  Recommend 0.
        type: string
      productCode:
        description: Numeric NACS code.
        type: string
      quantity:
        description: Quantity of the item.  NNNNN.DDD
        format: double
        type: number
      unitCost:
        description: Unit cost of the item.  DDDDD.CC
        format: double
        type: number
      unitOfMeasure:
        description: Code for units of measurement.
        type: string
      vatType:
        description: >-
          Type of value added taxes being used. Not applicable for US merchants.
          (tag must be present, but can be empty)
        type: string
    required:
      - debitCreditCode
      - discountCode
      - extendedItemAmount
      - itemCommodityCode
      - itemDescription
      - itemDiscountRate
      - lineItemDiscountAmount
      - lineItemTotalAmount
      - lineItemVatAmount
      - lineItemVatRate
      - netGrossCode
      - productCode
      - quantity
      - unitCost
      - unitOfMeasure
  POST_FleetLineItem_v1_return_transactionId_paymentType:
    description: FleetLineItem
    properties:
      alternateTaxIdentifier:
        description: >-
          Tax identification number of the merchant reporting the alternate tax
          amount.  Not applicable for US merchants. (tag must be present, but
          can be empty)
        type: string
      debitCreditCode:
        description: >-
          Indicates whether extendedItemAmount is a Credit (taking away from the
          total amount of the sale) or Debit (adding to the total amount of the
          sale).  Recommend 0
        type: string
      discountCode:
        description: >-
          Indicates whether discount was applied to the purchase price of the
          item.  Recommend 0.
        type: string
      extendedItemAmount:
        description: >-
          Amount of the item (unit price multiplied by quantity only). 
          DDDDDDDDD.CC
        type: string
      itemCommodityCode:
        description: >-
          International description code of the individual good or service being
          supplied.  Recommend using numeric NACS code.
        type: string
      itemDescription:
        description: Item Description.
        type: string
      itemDiscountRate:
        description: >-
          Discount rate for the line item.  Submitted as a percentage. 
          Two-digit implied string.  Recommend 0.  For example, if 10.42%,
          submit 1042
        type: string
      lineItemDiscountAmount:
        description: >-
          Discount amount applied to the line item.  This field should be 0.00
          if the unit cost reflects a discount price or if no line item discount
          applies.  DDDDDDDDD.CC
        format: double
        type: number
      lineItemTotalAmount:
        description: >-
          Total full amount associated with the line item (UnitCost * Quantity)
          - LineItemDiscountAmount for that item. DDDDDDDDD.CC
        format: double
        type: number
      lineItemVatAmount:
        description: >-
          Amount of any sales or value added taxes associated with the item. 
          Recommend 0.00.  DDDDDDDDD.CC
        type: string
      lineItemVatRate:
        description: >-
          Tax rate used to calculate LineItemVATAmount.  Submitted as a
          percentage.  Two-digit implied string.  Recommend 0.  For example, if
          10.42%, submit 1042
        type: string
      netGrossCode:
        description: Indicates whether extended item amount included the tax.  Recommend 0.
        type: string
      productCode:
        description: Numeric NACS code.
        type: string
      quantity:
        description: Quantity of the item.  NNNNN.DDD
        format: double
        type: number
      unitCost:
        description: Unit cost of the item.  DDDDD.CC
        format: double
        type: number
      unitOfMeasure:
        description: Code for units of measurement.
        type: string
      vatType:
        description: >-
          Type of value added taxes being used. Not applicable for US merchants.
          (tag must be present, but can be empty)
        type: string
    required:
      - debitCreditCode
      - discountCode
      - extendedItemAmount
      - itemCommodityCode
      - itemDescription
      - itemDiscountRate
      - lineItemDiscountAmount
      - lineItemTotalAmount
      - lineItemVatAmount
      - lineItemVatRate
      - netGrossCode
      - productCode
      - quantity
      - unitCost
      - unitOfMeasure
  POST_FleetLineItem_v1_sale:
    description: FleetLineItem
    properties:
      alternateTaxIdentifier:
        description: >-
          Tax identification number of the merchant reporting the alternate tax
          amount.  Not applicable for US merchants. (tag must be present, but
          can be empty)
        type: string
      debitCreditCode:
        description: >-
          Indicates whether extendedItemAmount is a Credit (taking away from the
          total amount of the sale) or Debit (adding to the total amount of the
          sale).  Recommend 0
        type: string
      discountCode:
        description: >-
          Indicates whether discount was applied to the purchase price of the
          item.  Recommend 0.
        type: string
      extendedItemAmount:
        description: >-
          Amount of the item (unit price multiplied by quantity only). 
          DDDDDDDDD.CC
        type: string
      itemCommodityCode:
        description: >-
          International description code of the individual good or service being
          supplied.  Recommend using numeric NACS code.
        type: string
      itemDescription:
        description: Item Description.
        type: string
      itemDiscountRate:
        description: >-
          Discount rate for the line item.  Submitted as a percentage. 
          Two-digit implied string.  Recommend 0.  For example, if 10.42%,
          submit 1042
        type: string
      lineItemDiscountAmount:
        description: >-
          Discount amount applied to the line item.  This field should be 0.00
          if the unit cost reflects a discount price or if no line item discount
          applies.  DDDDDDDDD.CC
        format: double
        type: number
      lineItemTotalAmount:
        description: >-
          Total full amount associated with the line item (UnitCost * Quantity)
          - LineItemDiscountAmount for that item. DDDDDDDDD.CC
        format: double
        type: number
      lineItemVatAmount:
        description: >-
          Amount of any sales or value added taxes associated with the item. 
          Recommend 0.00.  DDDDDDDDD.CC
        type: string
      lineItemVatRate:
        description: >-
          Tax rate used to calculate LineItemVATAmount.  Submitted as a
          percentage.  Two-digit implied string.  Recommend 0.  For example, if
          10.42%, submit 1042
        type: string
      netGrossCode:
        description: Indicates whether extended item amount included the tax.  Recommend 0.
        type: string
      productCode:
        description: Numeric NACS code.
        type: string
      quantity:
        description: Quantity of the item.  NNNNN.DDD
        format: double
        type: number
      unitCost:
        description: Unit cost of the item.  DDDDD.CC
        format: double
        type: number
      unitOfMeasure:
        description: Code for units of measurement.
        type: string
      vatType:
        description: >-
          Type of value added taxes being used. Not applicable for US merchants.
          (tag must be present, but can be empty)
        type: string
    required:
      - debitCreditCode
      - discountCode
      - extendedItemAmount
      - itemCommodityCode
      - itemDescription
      - itemDiscountRate
      - lineItemDiscountAmount
      - lineItemTotalAmount
      - lineItemVatAmount
      - lineItemVatRate
      - netGrossCode
      - productCode
      - quantity
      - unitCost
      - unitOfMeasure
  POST_FleetLineItem_v1_sale_transactionId_return_paymentType:
    description: FleetLineItem
    properties:
      alternateTaxIdentifier:
        description: >-
          Tax identification number of the merchant reporting the alternate tax
          amount.  Not applicable for US merchants. (tag must be present, but
          can be empty)
        type: string
      debitCreditCode:
        description: >-
          Indicates whether extendedItemAmount is a Credit (taking away from the
          total amount of the sale) or Debit (adding to the total amount of the
          sale).  Recommend 0
        type: string
      discountCode:
        description: >-
          Indicates whether discount was applied to the purchase price of the
          item.  Recommend 0.
        type: string
      extendedItemAmount:
        description: >-
          Amount of the item (unit price multiplied by quantity only). 
          DDDDDDDDD.CC
        type: string
      itemCommodityCode:
        description: >-
          International description code of the individual good or service being
          supplied.  Recommend using numeric NACS code.
        type: string
      itemDescription:
        description: Item Description.
        type: string
      itemDiscountRate:
        description: >-
          Discount rate for the line item.  Submitted as a percentage. 
          Two-digit implied string.  Recommend 0.  For example, if 10.42%,
          submit 1042
        type: string
      lineItemDiscountAmount:
        description: >-
          Discount amount applied to the line item.  This field should be 0.00
          if the unit cost reflects a discount price or if no line item discount
          applies.  DDDDDDDDD.CC
        format: double
        type: number
      lineItemTotalAmount:
        description: >-
          Total full amount associated with the line item (UnitCost * Quantity)
          - LineItemDiscountAmount for that item. DDDDDDDDD.CC
        format: double
        type: number
      lineItemVatAmount:
        description: >-
          Amount of any sales or value added taxes associated with the item. 
          Recommend 0.00.  DDDDDDDDD.CC
        type: string
      lineItemVatRate:
        description: >-
          Tax rate used to calculate LineItemVATAmount.  Submitted as a
          percentage.  Two-digit implied string.  Recommend 0.  For example, if
          10.42%, submit 1042
        type: string
      netGrossCode:
        description: Indicates whether extended item amount included the tax.  Recommend 0.
        type: string
      productCode:
        description: Numeric NACS code.
        type: string
      quantity:
        description: Quantity of the item.  NNNNN.DDD
        format: double
        type: number
      unitCost:
        description: Unit cost of the item.  DDDDD.CC
        format: double
        type: number
      unitOfMeasure:
        description: Code for units of measurement.
        type: string
      vatType:
        description: >-
          Type of value added taxes being used. Not applicable for US merchants.
          (tag must be present, but can be empty)
        type: string
    required:
      - debitCreditCode
      - discountCode
      - extendedItemAmount
      - itemCommodityCode
      - itemDescription
      - itemDiscountRate
      - lineItemDiscountAmount
      - lineItemTotalAmount
      - lineItemVatAmount
      - lineItemVatRate
      - netGrossCode
      - productCode
      - quantity
      - unitCost
      - unitOfMeasure
  POST_Fleet_v1_credit:
    description: Fleet
    properties:
      destinationCountryCode:
        description: Country code where goods are being shipped.
        type: string
      destinationZipCode:
        description: >-
          Postal/Zip Code of the address to where the purchased goods are being
          shipped. Recommend using merchant zip code for card-present.
        type: string
      discountAmount:
        description: >-
          Discount amount applied to the line item total.  This field should be
          0.00 if the unit cost reflects a discount price or if no line item
          discount applies.
        type: string
      lineItemCount:
        description: >-
          Number of line items included in transaction. Fleet supports 1 to 7
          line items.
        type: string
      lineItemDetail:
        $ref: '#/definitions/POST_FleetLineItemDetail_v1_credit'
        description: >-
          LineItemDetail includes the required Level III LineItem fields to be
          submitted.
      orderDate:
        description: Purchase order date.  YYYYMMDD
        type: string
      shipfromZipCode:
        description: >-
          Postal/Zip Code of the address to where the purchased goods are being
          shipped. Recommend using merchant zip code for card-present.
        type: string
      summaryCommodityCode:
        description: International description code of overall goods or services.
        type: string
    required:
      - destinationCountryCode
      - destinationZipCode
      - discountAmount
      - lineItemCount
      - lineItemDetail
      - orderDate
      - shipfromZipCode
      - summaryCommodityCode
  POST_Fleet_v1_refund:
    description: Fleet
    properties:
      destinationCountryCode:
        description: Country code where goods are being shipped.
        type: string
      destinationZipCode:
        description: >-
          Postal/Zip Code of the address to where the purchased goods are being
          shipped. Recommend using merchant zip code for card-present.
        type: string
      discountAmount:
        description: >-
          Discount amount applied to the line item total.  This field should be
          0.00 if the unit cost reflects a discount price or if no line item
          discount applies.
        type: string
      lineItemCount:
        description: >-
          Number of line items included in transaction. Fleet supports 1 to 7
          line items.
        type: string
      lineItemDetail:
        $ref: '#/definitions/POST_FleetLineItemDetail_v1_refund'
        description: >-
          LineItemDetail includes the required Level III LineItem fields to be
          submitted.
      orderDate:
        description: Purchase order date.  YYYYMMDD
        type: string
      shipfromZipCode:
        description: >-
          Postal/Zip Code of the address to where the purchased goods are being
          shipped. Recommend using merchant zip code for card-present.
        type: string
      summaryCommodityCode:
        description: International description code of overall goods or services.
        type: string
    required:
      - destinationCountryCode
      - destinationZipCode
      - discountAmount
      - lineItemCount
      - lineItemDetail
      - orderDate
      - shipfromZipCode
      - summaryCommodityCode
  POST_Fleet_v1_return_transactionId_paymentType:
    description: Fleet
    properties:
      destinationCountryCode:
        description: Country code where goods are being shipped.
        type: string
      destinationZipCode:
        description: >-
          Postal/Zip Code of the address to where the purchased goods are being
          shipped. Recommend using merchant zip code for card-present.
        type: string
      discountAmount:
        description: >-
          Discount amount applied to the line item total.  This field should be
          0.00 if the unit cost reflects a discount price or if no line item
          discount applies.
        type: string
      lineItemCount:
        description: >-
          Number of line items included in transaction. Fleet supports 1 to 7
          line items.
        type: string
      lineItemDetail:
        $ref: >-
          #/definitions/POST_FleetLineItemDetail_v1_return_transactionId_paymentType
        description: >-
          LineItemDetail includes the required Level III LineItem fields to be
          submitted.
      orderDate:
        description: Purchase order date.  YYYYMMDD
        type: string
      shipfromZipCode:
        description: >-
          Postal/Zip Code of the address to where the purchased goods are being
          shipped. Recommend using merchant zip code for card-present.
        type: string
      summaryCommodityCode:
        description: International description code of overall goods or services.
        type: string
    required:
      - destinationCountryCode
      - destinationZipCode
      - discountAmount
      - lineItemCount
      - lineItemDetail
      - orderDate
      - shipfromZipCode
      - summaryCommodityCode
  POST_Fleet_v1_sale:
    description: Fleet
    properties:
      destinationCountryCode:
        description: Country code where goods are being shipped.
        type: string
      destinationZipCode:
        description: >-
          Postal/Zip Code of the address to where the purchased goods are being
          shipped. Recommend using merchant zip code for card-present.
        type: string
      discountAmount:
        description: >-
          Discount amount applied to the line item total.  This field should be
          0.00 if the unit cost reflects a discount price or if no line item
          discount applies.
        type: string
      lineItemCount:
        description: >-
          Number of line items included in transaction. Fleet supports 1 to 7
          line items.
        type: string
      lineItemDetail:
        $ref: '#/definitions/POST_FleetLineItemDetail_v1_sale'
        description: >-
          LineItemDetail includes the required Level III LineItem fields to be
          submitted.
      orderDate:
        description: Purchase order date.  YYYYMMDD
        type: string
      shipfromZipCode:
        description: >-
          Postal/Zip Code of the address to where the purchased goods are being
          shipped. Recommend using merchant zip code for card-present.
        type: string
      summaryCommodityCode:
        description: International description code of overall goods or services.
        type: string
    required:
      - destinationCountryCode
      - destinationZipCode
      - discountAmount
      - lineItemCount
      - lineItemDetail
      - orderDate
      - shipfromZipCode
      - summaryCommodityCode
  POST_Fleet_v1_sale_transactionId_return_paymentType:
    description: Fleet
    properties:
      destinationCountryCode:
        description: Country code where goods are being shipped.
        type: string
      destinationZipCode:
        description: >-
          Postal/Zip Code of the address to where the purchased goods are being
          shipped. Recommend using merchant zip code for card-present.
        type: string
      discountAmount:
        description: >-
          Discount amount applied to the line item total.  This field should be
          0.00 if the unit cost reflects a discount price or if no line item
          discount applies.
        type: string
      lineItemCount:
        description: >-
          Number of line items included in transaction. Fleet supports 1 to 7
          line items.
        type: string
      lineItemDetail:
        $ref: >-
          #/definitions/POST_FleetLineItemDetail_v1_sale_transactionId_return_paymentType
        description: >-
          LineItemDetail includes the required Level III LineItem fields to be
          submitted.
      orderDate:
        description: Purchase order date.  YYYYMMDD
        type: string
      shipfromZipCode:
        description: >-
          Postal/Zip Code of the address to where the purchased goods are being
          shipped. Recommend using merchant zip code for card-present.
        type: string
      summaryCommodityCode:
        description: International description code of overall goods or services.
        type: string
    required:
      - destinationCountryCode
      - destinationZipCode
      - discountAmount
      - lineItemCount
      - lineItemDetail
      - orderDate
      - shipfromZipCode
      - summaryCommodityCode
  POST_ForceCreditRequestConfiguration_v1_force_credit:
    description: ForceCreditRequestConfiguration
    properties:
      allowPartialApprovals:
        description: 'If set to false, partial approvals are not allowed'
        type: boolean
      cardReadRetries:
        description: "Number of retries in case of bad card read. The\_default\_value\_is\_1."
        format: int32
        type: integer
      checkForDuplicateTransactions:
        description: >-
          If set to true, enables duplicate checking logic for the transaction
          at the host.
        type: boolean
      isManualEntryAllowed:
        description: >-
          Use this parameter to allow manual entry of card account numbers on
          the PIN pad.
        type: string
      marketCode:
        description: 'The market code of the transaction. '
        type: string
      promptForSignature:
        description: >-
          Specifies how the signature prompt should be handled for the request.
          If a value is not provided, Never will be used. See <a
          href='https://triposcert.vantiv.com/api/help/kb/signaturePrompt.html'>Signature Prompt</a>.
        type: string
      provisionalAmount:
        description: >-
          Override provisional amount used for QC transactions, which is $1.00
          by default
        type: string
  POST_ForceCreditRequest_v1_force_credit:
    description: ForceCreditRequest
    properties:
      address:
        $ref: '#/definitions/POST_Address_v1_force_credit'
        description: The cardholder address information for the transaction.
      approvalNumber:
        description: The approval number of a voice authorization
        type: string
      autoRental:
        $ref: '#/definitions/POST_AutoRental_v1_force_credit'
        description: >-
          The auto rental parameters to be passed in for an auto rental
          transaction. <a href='https://triposcert.vantiv.com/api/help/kb/autorental.html'>more&raquo;</a>
      cardHolderPresentCode:
        description: >-
          Defines whether the cardholder is present at the transaction. This
          value is optional, but recommended to be set. If this value is not set
          in the request, it will be automatically set based on the market code.
        type: string
      checkForPreReadId:
        description: >-
          Flag to support 'PreReadId feature in quick chip' transaction request.
          This will take precedence over triPOS.config flag.
        type: boolean
      clerkNumber:
        description: An optional clerk number for reference.
        type: string
      commercialCardCustomerCode:
        description: >-
          The commercial card customer code for the transaction. This is for
          Level II.
        type: string
      configuration:
        $ref: '#/definitions/POST_ForceCreditRequestConfiguration_v1_force_credit'
        description: >-
          Any value included in this section will override the corresponding
          value set in the triPOS.config
      displayTransactionAmount:
        description: Display the transaction amount during card read.
        type: boolean
      invokeManualEntry:
        description: ' Invokes manual card entry.'
        type: boolean
      isCscSupported:
        description: >-
          Invokes prompt for cardholder to enter card security code for manual
          keyed card entry.
        type: string
      laneId:
        description: Specifies which lane to use.
        format: int32
        type: integer
      lodging:
        $ref: '#/definitions/POST_LodgingTransactionCompletion_v1_force_credit'
        description: >-
          The lodging parameters to be passed in for a lodging transaction. <a
          href='https://triposcert.vantiv.com/api/help/kb/lodging.html'>more&raquo;</a>
      networkTransactionID:
        description: >-
          The card brand specific transaction ID that should be stored by the
          integrator.
        type: string
      preRead:
        description: >-
          Flag indicating desire to process force credit as PreRead (i.e. - do
          ONLY Pre-Read operations, then expecting next endpoint call to be
          QuickChip) <a
          href='https://triposcert.vantiv.com/api/help/kb/cloud/QuickChipConfiguration.html'>more&raquo;</a>.
        type: boolean
      preReadId:
        $ref: '#/definitions/POST_Guid_v1_force_credit'
        description: >-
          The preReadId returned in the pre-read response. This value should be
          a GUID.<a
          href='..\help\kb\QuickChipWithPreReadId.html'>more&raquo;</a>.
      quickChip:
        description: >-
          Flag indicating desire to process force credit as QuickChip (i.e. -
          Pre-Read has been previously performed) <a
          href='https://triposcert.vantiv.com/api/help/kb/cloud/QuickChipConfiguration.html'>more&raquo;</a>.
        type: boolean
      recurringPaymentType:
        description: Intent of why the credentials are being stored.
        type: string
      referenceNumber:
        description: A user defined reference number.
        type: string
      salesTaxAmount:
        description: >-
          The amount of sales tax for the transaction. This is for Level II,
          submit amount for tax or 0.00 for tax-exempt.
        format: double
        type: number
      shiftId:
        description: An optional shift id for reference.
        type: string
      submissionType:
        description: Specifies the type of transaction.
        type: string
      ticketNumber:
        description: An optional ticket number.
        type: string
      transactionAmount:
        description: >-
          The total transaction amount. This is the amount of funds to move on
          the card
        type: string
    required:
      - approvalNumber
      - laneId
      - transactionAmount
  POST_Guid_v1_authorization:
    description: Guid
  POST_Guid_v1_credit:
    description: Guid
  POST_Guid_v1_force_credit:
    description: Guid
  POST_Guid_v1_refund:
    description: Guid
  POST_Guid_v1_sale:
    description: Guid
  POST_Healthcare_v1_authorization:
    description: Healthcare
    properties:
      clinic:
        description: >-
          The total amount of healthcare-qualified goods that fall into the
          category of 'clinic'.
        format: double
        type: number
      dental:
        description: >-
          The total amount of healthcare-qualified goods that fall into the
          category of 'dental'.
        format: double
        type: number
      prescription:
        description: >-
          The total amount of healthcare-qualified goods that fall into the
          category of 'prescription'.
        format: double
        type: number
      total:
        description: >-
          The total amount of healthcare-qualified goods. If any healthcare
          values are included, this value is required to be present.
        format: double
        type: number
      vision:
        description: >-
          The total amount of healthcare-qualified goods that fall into the
          category of 'vision'.
        format: double
        type: number
  POST_Healthcare_v1_authorization_paymentAccountId:
    description: Healthcare
    properties:
      clinic:
        description: >-
          The total amount of healthcare-qualified goods that fall into the
          category of 'clinic'.
        format: double
        type: number
      dental:
        description: >-
          The total amount of healthcare-qualified goods that fall into the
          category of 'dental'.
        format: double
        type: number
      prescription:
        description: >-
          The total amount of healthcare-qualified goods that fall into the
          category of 'prescription'.
        format: double
        type: number
      total:
        description: >-
          The total amount of healthcare-qualified goods. If any healthcare
          values are included, this value is required to be present.
        format: double
        type: number
      vision:
        description: >-
          The total amount of healthcare-qualified goods that fall into the
          category of 'vision'.
        format: double
        type: number
  POST_Healthcare_v1_authorization_token:
    description: Healthcare
    properties:
      clinic:
        description: >-
          The total amount of healthcare-qualified goods that fall into the
          category of 'clinic'.
        format: double
        type: number
      dental:
        description: >-
          The total amount of healthcare-qualified goods that fall into the
          category of 'dental'.
        format: double
        type: number
      prescription:
        description: >-
          The total amount of healthcare-qualified goods that fall into the
          category of 'prescription'.
        format: double
        type: number
      total:
        description: >-
          The total amount of healthcare-qualified goods. If any healthcare
          values are included, this value is required to be present.
        format: double
        type: number
      vision:
        description: >-
          The total amount of healthcare-qualified goods that fall into the
          category of 'vision'.
        format: double
        type: number
  POST_Healthcare_v1_sale:
    description: Healthcare
    properties:
      clinic:
        description: >-
          The total amount of healthcare-qualified goods that fall into the
          category of 'clinic'.
        format: double
        type: number
      dental:
        description: >-
          The total amount of healthcare-qualified goods that fall into the
          category of 'dental'.
        format: double
        type: number
      prescription:
        description: >-
          The total amount of healthcare-qualified goods that fall into the
          category of 'prescription'.
        format: double
        type: number
      total:
        description: >-
          The total amount of healthcare-qualified goods. If any healthcare
          values are included, this value is required to be present.
        format: double
        type: number
      vision:
        description: >-
          The total amount of healthcare-qualified goods that fall into the
          category of 'vision'.
        format: double
        type: number
  POST_Healthcare_v1_sale_paymentAccountId:
    description: Healthcare
    properties:
      clinic:
        description: >-
          The total amount of healthcare-qualified goods that fall into the
          category of 'clinic'.
        format: double
        type: number
      dental:
        description: >-
          The total amount of healthcare-qualified goods that fall into the
          category of 'dental'.
        format: double
        type: number
      prescription:
        description: >-
          The total amount of healthcare-qualified goods that fall into the
          category of 'prescription'.
        format: double
        type: number
      total:
        description: >-
          The total amount of healthcare-qualified goods. If any healthcare
          values are included, this value is required to be present.
        format: double
        type: number
      vision:
        description: >-
          The total amount of healthcare-qualified goods that fall into the
          category of 'vision'.
        format: double
        type: number
  POST_Healthcare_v1_sale_token:
    description: Healthcare
    properties:
      clinic:
        description: >-
          The total amount of healthcare-qualified goods that fall into the
          category of 'clinic'.
        format: double
        type: number
      dental:
        description: >-
          The total amount of healthcare-qualified goods that fall into the
          category of 'dental'.
        format: double
        type: number
      prescription:
        description: >-
          The total amount of healthcare-qualified goods that fall into the
          category of 'prescription'.
        format: double
        type: number
      total:
        description: >-
          The total amount of healthcare-qualified goods. If any healthcare
          values are included, this value is required to be present.
        format: double
        type: number
      vision:
        description: >-
          The total amount of healthcare-qualified goods that fall into the
          category of 'vision'.
        format: double
        type: number
  POST_IdleRequest_v1_idle:
    description: IdleRequest
    properties:
      laneId:
        description: Specifies which lane to use.
        format: int32
        type: integer
    required:
      - laneId
  POST_IncrementalAuthorizationRequest_v1_authorization_transactionId_incremental:
    description: IncrementalAuthorizationRequest
    properties:
      autoRental:
        $ref: >-
          #/definitions/POST_AutoRentalBasic_v1_authorization_transactionId_incremental
        description: >-
          The auto rental parameters to be passed in for an auto rental
          transaction. <a href='https://triposcert.vantiv.com/api/help/kb/autorental.html'>more&raquo;</a>
      cardHolderPresentCode:
        description: >-
          Defines whether the cardholder is present at the transaction. This
          value is optional, but recommended to be set. If this value is not set
          in the request, it will be automatically set based on the market code.
        type: string
      clerkNumber:
        description: An optional clerk number for reference.
        type: string
      configuration:
        $ref: >-
          #/definitions/POST_TransactionIdRequestConfiguration_v1_authorization_transactionId_incremental
        description: Applicable configuration values that can be set per request.
      estimatedAmountIndicator:
        description: >-
          The EstimatedAmountIndicator can be used by merchants/integrators to
          define the TransactionAmount submitted to Express either as an
          Estimated Amount (i.e. amount to charge cardholder may change) or a
          Final Amount (i.e. amount to charge cardholder will not change).  It
          will be a 1-character request field supporting the following request
          settings:
        type: string
      getToken:
        description: >-
          To retrieve Token in the transaction. <a
          href='https://triposcert.vantiv.com/api/help/kb/GetToken.html'>more&raquo;</a>
        type: string
      laneId:
        description: Specifies which lane to use.
        format: int32
        type: integer
      lodging:
        $ref: >-
          #/definitions/POST_LodgingIncrementalAuthorization_v1_authorization_transactionId_incremental
        description: >-
          The lodging parameter to be passed in for a lodging transaction. <a
          href='https://triposcert.vantiv.com/api/help/kb/lodging.html'>more&raquo;</a>
      referenceNumber:
        description: A user defined reference number.
        type: string
      shiftId:
        description: An optional shift id for reference.
        type: string
      ticketNumber:
        description: An optional ticket number.
        type: string
      transactionAmount:
        description: The amount by which to increase the authorization amount.
        format: double
        type: number
    required:
      - laneId
      - transactionAmount
  POST_LodgingAuthorization_v1_authorization:
    description: LodgingAuthorization
    properties:
      duration:
        description: The number of hotel stay days. Set to 1 for no show.
        format: int32
        type: integer
      prestigiousPropertyCode:
        description: >-
          The lodging prestigious property code. For an empty or invalid value,
          this parameter defaults to NonParticipant.
        type: string
  POST_LodgingAuthorization_v1_credit:
    description: LodgingAuthorization
    properties:
      duration:
        description: The number of hotel stay days. Set to 1 for no show.
        format: int32
        type: integer
      prestigiousPropertyCode:
        description: >-
          The lodging prestigious property code. For an empty or invalid value,
          this parameter defaults to NonParticipant.
        type: string
  POST_LodgingAuthorization_v1_refund:
    description: LodgingAuthorization
    properties:
      duration:
        description: The number of hotel stay days. Set to 1 for no show.
        format: int32
        type: integer
      prestigiousPropertyCode:
        description: >-
          The lodging prestigious property code. For an empty or invalid value,
          this parameter defaults to NonParticipant.
        type: string
  POST_LodgingAuthorization_v1_return_transactionId_paymentType:
    description: LodgingAuthorization
    properties:
      duration:
        description: The number of hotel stay days. Set to 1 for no show.
        format: int32
        type: integer
      prestigiousPropertyCode:
        description: >-
          The lodging prestigious property code. For an empty or invalid value,
          this parameter defaults to NonParticipant.
        type: string
  POST_LodgingAuthorization_v1_sale_transactionId_return_paymentType:
    description: LodgingAuthorization
    properties:
      duration:
        description: The number of hotel stay days. Set to 1 for no show.
        format: int32
        type: integer
      prestigiousPropertyCode:
        description: >-
          The lodging prestigious property code. For an empty or invalid value,
          this parameter defaults to NonParticipant.
        type: string
  POST_LodgingIncrementalAuthorization_v1_authorization_transactionId_incremental:
    description: LodgingIncrementalAuthorization
    properties:
      duration:
        description: The number of hotel stay days. Set to 1 for no show.
        format: int32
        type: integer
  POST_LodgingTransactionCompletion_v1_authorization_transactionId_completion:
    description: LodgingTransactionCompletion
    properties:
      agreementNumber:
        description: The lodging agreement number.
        type: string
      chargeType:
        description: >-
          The lodging charge type. For an empty or invalid value, this parameter
          defaults to Default.
        type: string
      checkInDate:
        description: >-
          The check-in date for the lodging stay. Must be in the ISO 8601 format
          of YYYY-MM-DD.
        type: string
      checkOutDate:
        description: >-
          The check-out date for the lodging stay. Must be in the ISO 8601
          format of YYYY-MM-DD.
        type: string
      customerName:
        description: The lodging customer name.
        type: string
      duration:
        description: The number of hotel stay days. Set to 1 for no show.
        format: int32
        type: integer
      extraChargesDetail:
        description: >-
          Pass in up to 6 values that describe the extra charges. For an empty
          or invalid value, this parameter defaults to NotUsed.
        items:
          enum:
            - NotUsed
            - Reserved
            - Restaurant
            - GiftShop
            - MiniBar
            - Telephone
            - Other
            - Laundry
          type: string
        type: array
      noShow:
        description: 'Set to true to indicate no show. Otherwise, value defaults to false.'
        type: boolean
      prestigiousPropertyCode:
        description: >-
          The lodging prestigious property code. For an empty or invalid value,
          this parameter defaults to NonParticipant.
        type: string
      roomAmount:
        description: The nightly rate for one room.
        format: double
        type: number
      specialProgramCode:
        description: >-
          The lodging special program code. For an empty or invalid value, this
          parameter defaults to Default.
        type: string
  POST_LodgingTransactionCompletion_v1_force_credit:
    description: LodgingTransactionCompletion
    properties:
      agreementNumber:
        description: The lodging agreement number.
        type: string
      chargeType:
        description: >-
          The lodging charge type. For an empty or invalid value, this parameter
          defaults to Default.
        type: string
      checkInDate:
        description: >-
          The check-in date for the lodging stay. Must be in the ISO 8601 format
          of YYYY-MM-DD.
        type: string
      checkOutDate:
        description: >-
          The check-out date for the lodging stay. Must be in the ISO 8601
          format of YYYY-MM-DD.
        type: string
      customerName:
        description: The lodging customer name.
        type: string
      duration:
        description: The number of hotel stay days. Set to 1 for no show.
        format: int32
        type: integer
      extraChargesDetail:
        description: >-
          Pass in up to 6 values that describe the extra charges. For an empty
          or invalid value, this parameter defaults to NotUsed.
        items:
          enum:
            - NotUsed
            - Reserved
            - Restaurant
            - GiftShop
            - MiniBar
            - Telephone
            - Other
            - Laundry
          type: string
        type: array
      noShow:
        description: 'Set to true to indicate no show. Otherwise, value defaults to false.'
        type: boolean
      prestigiousPropertyCode:
        description: >-
          The lodging prestigious property code. For an empty or invalid value,
          this parameter defaults to NonParticipant.
        type: string
      roomAmount:
        description: The nightly rate for one room.
        format: double
        type: number
      specialProgramCode:
        description: >-
          The lodging special program code. For an empty or invalid value, this
          parameter defaults to Default.
        type: string
  POST_LodgingTransactionCompletion_v1_sale:
    description: LodgingTransactionCompletion
    properties:
      agreementNumber:
        description: The lodging agreement number.
        type: string
      chargeType:
        description: >-
          The lodging charge type. For an empty or invalid value, this parameter
          defaults to Default.
        type: string
      checkInDate:
        description: >-
          The check-in date for the lodging stay. Must be in the ISO 8601 format
          of YYYY-MM-DD.
        type: string
      checkOutDate:
        description: >-
          The check-out date for the lodging stay. Must be in the ISO 8601
          format of YYYY-MM-DD.
        type: string
      customerName:
        description: The lodging customer name.
        type: string
      duration:
        description: The number of hotel stay days. Set to 1 for no show.
        format: int32
        type: integer
      extraChargesDetail:
        description: >-
          Pass in up to 6 values that describe the extra charges. For an empty
          or invalid value, this parameter defaults to NotUsed.
        items:
          enum:
            - NotUsed
            - Reserved
            - Restaurant
            - GiftShop
            - MiniBar
            - Telephone
            - Other
            - Laundry
          type: string
        type: array
      noShow:
        description: 'Set to true to indicate no show. Otherwise, value defaults to false.'
        type: boolean
      prestigiousPropertyCode:
        description: >-
          The lodging prestigious property code. For an empty or invalid value,
          this parameter defaults to NonParticipant.
        type: string
      roomAmount:
        description: The nightly rate for one room.
        format: double
        type: number
      specialProgramCode:
        description: >-
          The lodging special program code. For an empty or invalid value, this
          parameter defaults to Default.
        type: string
  POST_Nullable_Boolean_v1_authorization:
    description: Nullable`Boolean`
    properties:
      hasValue:
        type: boolean
      value:
        type: boolean
    required:
      - hasValue
      - value
  POST_Nullable_Boolean_v1_authorization_paymentAccountId:
    description: Nullable`Boolean`
    properties:
      hasValue:
        type: boolean
      value:
        type: boolean
    required:
      - hasValue
      - value
  POST_Nullable_Boolean_v1_authorization_token:
    description: Nullable`Boolean`
    properties:
      hasValue:
        type: boolean
      value:
        type: boolean
    required:
      - hasValue
      - value
  POST_Nullable_Boolean_v1_authorization_transactionId_completion:
    description: Nullable`Boolean`
    properties:
      hasValue:
        type: boolean
      value:
        type: boolean
    required:
      - hasValue
      - value
  POST_Nullable_Boolean_v1_balance:
    description: Nullable`Boolean`
    properties:
      hasValue:
        type: boolean
      value:
        type: boolean
    required:
      - hasValue
      - value
  POST_Nullable_Boolean_v1_credit:
    description: Nullable`Boolean`
    properties:
      hasValue:
        type: boolean
      value:
        type: boolean
    required:
      - hasValue
      - value
  POST_Nullable_Boolean_v1_ebtVoucher:
    description: Nullable`Boolean`
    properties:
      hasValue:
        type: boolean
      value:
        type: boolean
    required:
      - hasValue
      - value
  POST_Nullable_Boolean_v1_force_credit:
    description: Nullable`Boolean`
    properties:
      hasValue:
        type: boolean
      value:
        type: boolean
    required:
      - hasValue
      - value
  POST_Nullable_Boolean_v1_gift_activate:
    description: Nullable`Boolean`
    properties:
      hasValue:
        type: boolean
      value:
        type: boolean
    required:
      - hasValue
      - value
  POST_Nullable_Boolean_v1_gift_balanceTransfer:
    description: Nullable`Boolean`
    properties:
      hasValue:
        type: boolean
      value:
        type: boolean
    required:
      - hasValue
      - value
  POST_Nullable_Boolean_v1_gift_close:
    description: Nullable`Boolean`
    properties:
      hasValue:
        type: boolean
      value:
        type: boolean
    required:
      - hasValue
      - value
  POST_Nullable_Boolean_v1_gift_reload:
    description: Nullable`Boolean`
    properties:
      hasValue:
        type: boolean
      value:
        type: boolean
    required:
      - hasValue
      - value
  POST_Nullable_Boolean_v1_gift_unload:
    description: Nullable`Boolean`
    properties:
      hasValue:
        type: boolean
      value:
        type: boolean
    required:
      - hasValue
      - value
  POST_Nullable_Boolean_v1_receipt:
    description: Nullable`Boolean`
    properties:
      hasValue:
        type: boolean
      value:
        type: boolean
    required:
      - hasValue
      - value
  POST_Nullable_Boolean_v1_refund:
    description: Nullable`Boolean`
    properties:
      hasValue:
        type: boolean
      value:
        type: boolean
    required:
      - hasValue
      - value
  POST_Nullable_Boolean_v1_refund_paymentAccountId:
    description: Nullable`Boolean`
    properties:
      hasValue:
        type: boolean
      value:
        type: boolean
    required:
      - hasValue
      - value
  POST_Nullable_Boolean_v1_refund_token:
    description: Nullable`Boolean`
    properties:
      hasValue:
        type: boolean
      value:
        type: boolean
    required:
      - hasValue
      - value
  POST_Nullable_Boolean_v1_return_transactionId_paymentType:
    description: Nullable`Boolean`
    properties:
      hasValue:
        type: boolean
      value:
        type: boolean
    required:
      - hasValue
      - value
  POST_Nullable_Boolean_v1_sale:
    description: Nullable`Boolean`
    properties:
      hasValue:
        type: boolean
      value:
        type: boolean
    required:
      - hasValue
      - value
  POST_Nullable_Boolean_v1_sale_paymentAccountId:
    description: Nullable`Boolean`
    properties:
      hasValue:
        type: boolean
      value:
        type: boolean
    required:
      - hasValue
      - value
  POST_Nullable_Boolean_v1_sale_token:
    description: Nullable`Boolean`
    properties:
      hasValue:
        type: boolean
      value:
        type: boolean
    required:
      - hasValue
      - value
  POST_Nullable_Boolean_v1_sale_transactionId_return_paymentType:
    description: Nullable`Boolean`
    properties:
      hasValue:
        type: boolean
      value:
        type: boolean
    required:
      - hasValue
      - value
  POST_Nullable_Decimal_v1_authorization:
    description: Nullable`Decimal`
    properties:
      hasValue:
        type: boolean
      value:
        format: double
        type: number
    required:
      - hasValue
      - value
  POST_Nullable_Decimal_v1_authorization_paymentAccountId:
    description: Nullable`Decimal`
    properties:
      hasValue:
        type: boolean
      value:
        format: double
        type: number
    required:
      - hasValue
      - value
  POST_Nullable_Decimal_v1_authorization_token:
    description: Nullable`Decimal`
    properties:
      hasValue:
        type: boolean
      value:
        format: double
        type: number
    required:
      - hasValue
      - value
  POST_Nullable_Decimal_v1_authorization_transactionId_completion:
    description: Nullable`Decimal`
    properties:
      hasValue:
        type: boolean
      value:
        format: double
        type: number
    required:
      - hasValue
      - value
  POST_Nullable_Decimal_v1_credit:
    description: Nullable`Decimal`
    properties:
      hasValue:
        type: boolean
      value:
        format: double
        type: number
    required:
      - hasValue
      - value
  POST_Nullable_Decimal_v1_force_credit:
    description: Nullable`Decimal`
    properties:
      hasValue:
        type: boolean
      value:
        format: double
        type: number
    required:
      - hasValue
      - value
  POST_Nullable_Decimal_v1_receipt:
    description: Nullable`Decimal`
    properties:
      hasValue:
        type: boolean
      value:
        format: double
        type: number
    required:
      - hasValue
      - value
  POST_Nullable_Decimal_v1_refund:
    description: Nullable`Decimal`
    properties:
      hasValue:
        type: boolean
      value:
        format: double
        type: number
    required:
      - hasValue
      - value
  POST_Nullable_Decimal_v1_return_transactionId_paymentType:
    description: Nullable`Decimal`
    properties:
      hasValue:
        type: boolean
      value:
        format: double
        type: number
    required:
      - hasValue
      - value
  POST_Nullable_Decimal_v1_sale:
    description: Nullable`Decimal`
    properties:
      hasValue:
        type: boolean
      value:
        format: double
        type: number
    required:
      - hasValue
      - value
  POST_Nullable_Decimal_v1_sale_paymentAccountId:
    description: Nullable`Decimal`
    properties:
      hasValue:
        type: boolean
      value:
        format: double
        type: number
    required:
      - hasValue
      - value
  POST_Nullable_Decimal_v1_sale_token:
    description: Nullable`Decimal`
    properties:
      hasValue:
        type: boolean
      value:
        format: double
        type: number
    required:
      - hasValue
      - value
  POST_Nullable_Decimal_v1_sale_transactionId_return_paymentType:
    description: Nullable`Decimal`
    properties:
      hasValue:
        type: boolean
      value:
        format: double
        type: number
    required:
      - hasValue
      - value
  POST_Nullable_Int32_v1_authorization:
    description: Nullable`Int32`
    properties:
      hasValue:
        type: boolean
      value:
        format: int32
        type: integer
    required:
      - hasValue
      - value
  POST_Nullable_Int32_v1_authorization_transactionId_completion:
    description: Nullable`Int32`
    properties:
      hasValue:
        type: boolean
      value:
        format: int32
        type: integer
    required:
      - hasValue
      - value
  POST_Nullable_Int32_v1_credit:
    description: Nullable`Int32`
    properties:
      hasValue:
        type: boolean
      value:
        format: int32
        type: integer
    required:
      - hasValue
      - value
  POST_Nullable_Int32_v1_force_credit:
    description: Nullable`Int32`
    properties:
      hasValue:
        type: boolean
      value:
        format: int32
        type: integer
    required:
      - hasValue
      - value
  POST_Nullable_Int32_v1_paymentAccount:
    description: Nullable`Int32`
    properties:
      hasValue:
        type: boolean
      value:
        format: int32
        type: integer
    required:
      - hasValue
      - value
  POST_Nullable_Int32_v1_paymentAccount_credit:
    description: Nullable`Int32`
    properties:
      hasValue:
        type: boolean
      value:
        format: int32
        type: integer
    required:
      - hasValue
      - value
  POST_Nullable_Int32_v1_refund:
    description: Nullable`Int32`
    properties:
      hasValue:
        type: boolean
      value:
        format: int32
        type: integer
    required:
      - hasValue
      - value
  POST_Nullable_Int32_v1_sale:
    description: Nullable`Int32`
    properties:
      hasValue:
        type: boolean
      value:
        format: int32
        type: integer
    required:
      - hasValue
      - value
  POST_Nullable_Int32_v1_token_omni:
    description: Nullable`Int32`
    properties:
      hasValue:
        type: boolean
      value:
        format: int32
        type: integer
    required:
      - hasValue
      - value
  POST_Nullable_Int32_v1_token_paymetric:
    description: Nullable`Int32`
    properties:
      hasValue:
        type: boolean
      value:
        format: int32
        type: integer
    required:
      - hasValue
      - value
  POST_Nullable_Int32_v1_token_worldpay:
    description: Nullable`Int32`
    properties:
      hasValue:
        type: boolean
      value:
        format: int32
        type: integer
    required:
      - hasValue
      - value
  POST_PaymentAccountAuthorizationRequest_v1_authorization_paymentAccountId:
    description: PaymentAccountAuthorizationRequest
    properties:
      address:
        $ref: '#/definitions/POST_Address_v1_authorization_paymentAccountId'
        description: The cardholder address information for the transaction.
      clerkNumber:
        description: An optional clerk number for reference.
        type: string
      configuration:
        $ref: >-
          #/definitions/POST_RequestConfiguration_v1_authorization_paymentAccountId
        description: >-
          Any value included in this section will override the corresponding
          value set in the triPOS.config
      convenienceFeeAmount:
        description: >-
          The convenience fee amount of the transaction. This amount is added to
          the TotalAmount before the cardholder is charged
        format: double
        type: number
      creditSurchargeAmount:
        description: >-
          The credit surcharge amount of the transaction. This amount is added
          to the TotalAmount before the cardholder is charged
        format: double
        type: number
      healthcare:
        $ref: '#/definitions/POST_Healthcare_v1_authorization_paymentAccountId'
        description: >-
          The healthcare section that contains all applicable
          healthcare-qualified amounts. <a
          href='https://triposcert.vantiv.com/api/help/kb/healthcare.html'>more&raquo;</a>
      laneId:
        description: Specifies which lane to use for the card sale.
        format: int32
        type: integer
      referenceNumber:
        description: A user defined reference number.
        type: string
      shiftId:
        description: An optional shift id for reference.
        type: string
      ticketNumber:
        description: An optional ticket number.
        type: string
      tipAmount:
        description: >-
          The tip amount of the transaction. This amount is added to the
          TotalAmount before the cardholder is charged.
        format: double
        type: number
      transactionAmount:
        description: >-
          The total transaction amount. This is the amount of funds to move on
          the card
        format: double
        type: number
    required:
      - laneId
      - transactionAmount
  POST_PaymentAccountRefundRequest_v1_refund_paymentAccountId:
    description: PaymentAccountRefundRequest
    properties:
      clerkNumber:
        description: An optional clerk number for reference.
        type: string
      configuration:
        $ref: '#/definitions/POST_RequestConfiguration_v1_refund_paymentAccountId'
        description: >-
          Any value included in this section will override the corresponding
          value set in the triPOS.config
      convenienceFeeAmount:
        description: >-
          The convenience fee amount of the transaction. This amount is added to
          the TotalAmount before the cardholder is charged
        format: double
        type: number
      laneId:
        description: Specifies which lane to use for the card sale.
        format: int32
        type: integer
      referenceNumber:
        description: A user defined reference number.
        type: string
      shiftId:
        description: An optional shift id for reference.
        type: string
      ticketNumber:
        description: An optional ticket number.
        type: string
      transactionAmount:
        description: >-
          The total transaction amount. This is the amount of funds to move on
          the card
        format: double
        type: number
    required:
      - laneId
      - transactionAmount
  POST_PaymentAccountSaleRequest_v1_sale_paymentAccountId:
    description: PaymentAccountSaleRequest
    properties:
      address:
        $ref: '#/definitions/POST_Address_v1_sale_paymentAccountId'
        description: The cardholder address information for the transaction.
      clerkNumber:
        description: An optional clerk number for reference.
        type: string
      configuration:
        $ref: '#/definitions/POST_RequestConfiguration_v1_sale_paymentAccountId'
        description: >-
          Any value included in this section will override the corresponding
          value set in the triPOS.config
      convenienceFeeAmount:
        description: >-
          The convenience fee amount of the transaction. This amount is added to
          the TotalAmount before the cardholder is charged
        format: double
        type: number
      creditSurchargeAmount:
        description: >-
          The credit surcharge amount of the transaction. This amount is added
          to the TotalAmount before the cardholder is charged
        format: double
        type: number
      healthcare:
        $ref: '#/definitions/POST_Healthcare_v1_sale_paymentAccountId'
        description: >-
          The healthcare section that contains all applicable
          healthcare-qualified amounts. <a
          href='https://triposcert.vantiv.com/api/help/kb/healthcare.html'>more&raquo;</a>
      laneId:
        description: Specifies which lane to use for the card sale.
        format: int32
        type: integer
      referenceNumber:
        description: A user defined reference number.
        type: string
      shiftId:
        description: An optional shift id for reference.
        type: string
      ticketNumber:
        description: An optional ticket number.
        type: string
      tipAmount:
        description: >-
          The tip amount of the transaction. This amount is added to the
          TotalAmount before the cardholder is charged.
        format: double
        type: number
      transactionAmount:
        description: >-
          The total transaction amount. This is the amount of funds to move on
          the card
        format: double
        type: number
    required:
      - laneId
      - transactionAmount
  POST_RebootLaneRequest_v1_reboot:
    description: RebootLaneRequest
    properties:
      laneId:
        description: >-
          The desired lane ID. The lane ID should be a maximum of six digits
          long.
        format: int32
        type: integer
    required:
      - laneId
  POST_ReceiptEmvDto_v1_receipt:
    description: ReceiptEmvDto
    properties:
      tags:
        description: >-
          A name value collection of additional EMV tags that are required to
          appear on the receipt.
        items:
          $ref: '#/definitions/POST_EmvTagKeyValue_v1_receipt'
        type: array
      applicationIdentifier:
        description: >-
          The Application Identifier also known as the AID. Identifies the
          application as described in ISO/IEC 7816-5. Printed receipts are
          required to contain the AID as hexadecimal characters.
        type: string
      applicationLabel:
        description: >-
          Mnemonic associated with the AID according to ISO/IEC 7816-5. If the
          Application Preferred Name is not available or the Issuer code table
          index is not supported, then the Application Label should be used on
          the receipt instead of the Application Preferred Name.
        type: string
      applicationPreferredName:
        description: >-
          Preferred mnemonic associated with the AID. When the Application
          Preferred Name is present and the Issuer code table index is
          supported, then this data element is mandatory on the receipt.
        type: string
      cryptogram:
        description: >-
          The EMV cryptogram type and value. It is a preferred best practice to
          include this data element on the receipt, but is not mandatory. This
          field contains cryptogram type followed by the cryptogram value.
        type: string
      issuerCodeTableIndex:
        description: >-
          Indicates the code table according to ISO/IEC 8859 for displaying the
          Application Preferred Name.
        type: string
    required:
      - applicationIdentifier
      - applicationLabel
      - applicationPreferredName
      - cryptogram
      - issuerCodeTableIndex
      - tags
  POST_ReceiptFleetDto_v1_receipt:
    description: ReceiptFleetDto
    properties:
      additionalPromptedData1:
        description: Additional prompted data 1 for the fleet transaction.
        type: string
      additionalPromptedData2:
        description: Additional prompted data 2 for the fleet transaction.
        type: string
      driverId:
        description: The driver ID for the fleet transaction.
        type: string
      employeeNumber:
        description: The employee number for the fleet transaction.
        type: string
      jobNumber:
        description: The Job number/Purchase/Work Order for the fleet transaction.
        type: string
      odometer:
        description: The odometer reading for the fleet transaction.
        type: string
      trailerNumber:
        description: The trailer number for the fleet transaction.
        type: string
      userId:
        description: The user ID for the fleet transaction.
        type: string
      vehicleId:
        description: The vehicle ID for the fleet transaction.
        type: string
    required:
      - additionalPromptedData1
      - additionalPromptedData2
      - driverId
      - employeeNumber
      - jobNumber
      - odometer
      - trailerNumber
      - userId
      - vehicleId
  POST_ReceiptRequest_v1_receipt:
    description: ReceiptRequest
    properties:
      accountNumber:
        description: The card account number used in the transaction.
        type: string
      accountType:
        description: The Account Type Checking/Savings used in the transaction.
        type: string
      approvalNumber:
        description: Approval number of the transaction.
        type: string
      cardHolderName:
        description: The cardholder name used in the transaction.
        type: string
      cardLogo:
        description: The card logo of the card used in the transaction.
        type: string
      cashbackAmount:
        description: Cashback amount the customer received.
        format: double
        type: number
      copyType:
        description: Indicates whether the receipt is a Merchant Copy or a Customer Copy.
        type: string
      countryCode:
        description: The country code used in the transaction.
        type: string
      currencyCode:
        description: The currency code used in the transaction.
        type: string
      customTemplate:
        description: A custom template that should be used instead of the default.
        type: string
      emv:
        $ref: '#/definitions/POST_ReceiptEmvDto_v1_receipt'
        description: The EMV information of the EMV card used in the transaction.
      entryMode:
        description: 'Entry method used to enter card information, swipe, chip, etc.'
        type: string
      fleet:
        $ref: '#/definitions/POST_ReceiptFleetDto_v1_receipt'
        description: The Fleet information of the Fleet card used in the transaction.
      footer:
        description: >-
          The list of individual lines of text to be displayed at the bottom of
          the receipt.
        items:
          type: string
        type: array
      header:
        description: >-
          The list of individual lines of text to be displayed at the top of the
          receipt.
        items:
          type: string
        type: array
      hostResponseCode:
        description: The code returned by the transaction's processing host.
        type: string
      isApproved:
        description: Indicates whether the transaction was approved.
        type: boolean
      laneId:
        description: The lane ID.
        format: int32
        type: integer
      language:
        description: The language used in the transaction.
        type: string
      pinVerified:
        description: Indicates whether the entered PIN was verified.
        type: boolean
      receiptType:
        description: The type of receipt.
        type: string
      referenceNumber:
        description: The transaction's reference number.
        type: string
      subTotalAmount:
        description: The subtotal amount of the transaction.
        format: double
        type: number
      surchargeAmount:
        description: The surcharge amount.
        format: double
        type: number
      terminalId:
        description: The ID of the terminal used in the transaction.
        type: string
      tipAmount:
        description: The tip amount.
        format: double
        type: number
      totalAmount:
        description: The total amount of the transaction.
        format: double
        type: number
      transactionDateTime:
        description: Date and time of the transaction.
        type: string
      transactionId:
        description: The ID of the transaction.
        type: string
    required:
      - accountNumber
      - cardLogo
      - entryMode
      - isApproved
      - laneId
      - referenceNumber
      - subTotalAmount
      - terminalId
      - transactionDateTime
  POST_RefundRequestConfiguration_v1_credit:
    description: RefundRequestConfiguration
    properties:
      allowPartialApprovals:
        description: 'If set to false, partial approvals are not allowed'
        type: boolean
      cardReadRetries:
        description: "Number of retries in case of bad card read. The\_default\_value\_is\_1."
        format: int32
        type: integer
      checkForDuplicateTransactions:
        description: >-
          If set to true, enables duplicate checking logic for the transaction
          at the host.
        type: boolean
      isGiftSupported:
        description: Use this parameter to allow Vantiv & Valutec gift cards to be used.
        type: string
      isManualEntryAllowed:
        description: >-
          Use this parameter to allow manual entry of card account numbers on
          the PIN pad.
        type: string
      marketCode:
        description: 'The market code of the transaction. '
        type: string
      promptForSignature:
        description: >-
          Specifies how the signature prompt should be handled for the request.
          If a value is not provided, Always will be used.  See <a
          href='https://triposcert.vantiv.com/api/help/kb/signaturePrompt.html'>Signature Prompt</a>.
        type: string
      provisionalAmount:
        description: >-
          Override provisional amount used for QC transactions, which is $1.00
          by default
        type: string
      userInputTimeout:
        description: Specifies the user input timeout.
        type: string
  POST_RefundRequestConfiguration_v1_refund:
    description: RefundRequestConfiguration
    properties:
      allowPartialApprovals:
        description: 'If set to false, partial approvals are not allowed'
        type: boolean
      cardReadRetries:
        description: "Number of retries in case of bad card read. The\_default\_value\_is\_1."
        format: int32
        type: integer
      checkForDuplicateTransactions:
        description: >-
          If set to true, enables duplicate checking logic for the transaction
          at the host.
        type: boolean
      isGiftSupported:
        description: Use this parameter to allow Vantiv & Valutec gift cards to be used.
        type: string
      isManualEntryAllowed:
        description: >-
          Use this parameter to allow manual entry of card account numbers on
          the PIN pad.
        type: string
      marketCode:
        description: 'The market code of the transaction. '
        type: string
      promptForSignature:
        description: >-
          Specifies how the signature prompt should be handled for the request.
          If a value is not provided, Always will be used.  See <a
          href='https://triposcert.vantiv.com/api/help/kb/signaturePrompt.html'>Signature Prompt</a>.
        type: string
      provisionalAmount:
        description: >-
          Override provisional amount used for QC transactions, which is $1.00
          by default
        type: string
      userInputTimeout:
        description: Specifies the user input timeout.
        type: string
  POST_RefundRequest_v1_credit:
    description: RefundRequest
    properties:
      address:
        $ref: '#/definitions/POST_Address_v1_credit'
        description: The cardholder address information for the transaction.
      autoRental:
        $ref: '#/definitions/POST_AutoRentalBasic_v1_credit'
        description: >-
          The auto rental parameters to be passed in for an auto rental
          transaction. <a href='https://triposcert.vantiv.com/api/help/kb/autorental.html'>more&raquo;</a>
      cardHolderPresentCode:
        description: >-
          Defines whether the cardholder is present at the transaction. This
          value is optional, but recommended to be set. If this value is not set
          in the request, it will be automatically set based on the market code.
        type: string
      checkForPreReadId:
        description: >-
          Flag to support 'PreReadId feature in quick chip' transaction request.
          This will take precedence over triPOS.config flag.
        type: boolean
      clerkNumber:
        description: An optional clerk number for reference.
        type: string
      commercialCardCustomerCode:
        description: >-
          The commercial card customer code for the transaction. This is for
          Level II.
        type: string
      configuration:
        $ref: '#/definitions/POST_RefundRequestConfiguration_v1_credit'
        description: >-
          Any value included in this section will override the corresponding
          value set in the triPOS.config
      convenienceFeeAmount:
        description: The convenience fee amount.
        format: double
        type: number
      displayTransactionAmount:
        description: Display the transaction amount during card read.
        type: boolean
      fleet:
        $ref: '#/definitions/POST_Fleet_v1_credit'
        description: >-
          The fleet section that contains all applicable fleet. <a
          href='https://triposcert.vantiv.com/api/help/kb/fleet.html'>more&raquo;</a>
      getToken:
        description: >-
          To retrieve Token in the transaction. <a
          href='https://triposcert.vantiv.com/api/help/kb/GetToken.html'>more&raquo;</a>
        type: string
      giftCardProgram:
        description: >-
          This field is for Valutec gift/loyalty card program. <br>'01' =
          Original Gift Card Program <br>'02' = Promotional Gift Card Program
          <br>'03' = Original Combo Card Program <br>'04' = Auto Rewards LPR
          Card Program <br>'05' = Original Loyalty Card Program
        type: string
      giftProgramType:
        description: >-
          This field is for Valutec gift/loyalty card type. The value 0 is for
          gift and 1 for loyalty
        type: string
      invokeManualEntry:
        description: ' Invokes manual card entry.'
        type: boolean
      isCscSupported:
        description: >-
          Invokes prompt for cardholder to enter card security code for manual
          keyed card entry.
        type: string
      laneId:
        description: Specifies which lane to use.
        format: int32
        type: integer
      lodging:
        $ref: '#/definitions/POST_LodgingAuthorization_v1_credit'
        description: >-
          The lodging parameters to be passed in for a lodging transaction. <a
          href='https://triposcert.vantiv.com/api/help/kb/lodging.html'>more&raquo;</a>
      pinlessPosConversionIndicator:
        description: >-
          Flag indicating desire to convert Credit card Refund transaction to a
          PINless Debit Card transaction. <a
          href='https://triposcert.vantiv.com/api/help/kb/PinlessDebitConversion.html'>more&raquo;</a>
        type: string
      preRead:
        description: >-
          Flag indicating desire to process refund as PreRead (i.e. - do ONLY
          Pre-Read operations, then expecting next endpoint call to be
          QuickChip) <a
          href='https://triposcert.vantiv.com/api/help/kb/cloud/QuickChipConfiguration.html'>more&raquo;</a>.
        type: boolean
      preReadId:
        $ref: '#/definitions/POST_Guid_v1_credit'
        description: >-
          The preReadId returned in the pre-read response. This value should be
          a GUID.<a
          href='..\help\kb\QuickChipWithPreReadId.html'>more&raquo;</a>.
      quickChip:
        description: >-
          Flag indicating desire to process refund as QuickChip (i.e. - Pre-Read
          has been previously performed) <a
          href='https://triposcert.vantiv.com/api/help/kb/cloud/QuickChipConfiguration.html'>more&raquo;</a>.
        type: boolean
      referenceNumber:
        description: A user defined reference number.
        type: string
      salesTaxAmount:
        description: >-
          The amount of sales tax for the transaction. This is for Level II,
          submit amount for tax or 0.00 for tax-exempt.
        format: double
        type: number
      shiftId:
        description: An optional shift id for reference.
        type: string
      storeCard:
        $ref: '#/definitions/POST_StoreCard_v1_credit'
        description: Information necessary to process a StoreCard transaction.
      ticketNumber:
        description: An optional ticket number.
        type: string
      transactionAmount:
        description: >-
          The total transaction amount. This is the amount of funds to move on
          the card
        type: string
    required:
      - laneId
      - transactionAmount
  POST_RefundRequest_v1_refund:
    description: RefundRequest
    properties:
      address:
        $ref: '#/definitions/POST_Address_v1_refund'
        description: The cardholder address information for the transaction.
      autoRental:
        $ref: '#/definitions/POST_AutoRentalBasic_v1_refund'
        description: >-
          The auto rental parameters to be passed in for an auto rental
          transaction. <a href='https://triposcert.vantiv.com/api/help/kb/autorental.html'>more&raquo;</a>
      cardHolderPresentCode:
        description: >-
          Defines whether the cardholder is present at the transaction. This
          value is optional, but recommended to be set. If this value is not set
          in the request, it will be automatically set based on the market code.
        type: string
      checkForPreReadId:
        description: >-
          Flag to support 'PreReadId feature in quick chip' transaction request.
          This will take precedence over triPOS.config flag.
        type: boolean
      clerkNumber:
        description: An optional clerk number for reference.
        type: string
      commercialCardCustomerCode:
        description: >-
          The commercial card customer code for the transaction. This is for
          Level II.
        type: string
      configuration:
        $ref: '#/definitions/POST_RefundRequestConfiguration_v1_refund'
        description: >-
          Any value included in this section will override the corresponding
          value set in the triPOS.config
      convenienceFeeAmount:
        description: The convenience fee amount.
        format: double
        type: number
      displayTransactionAmount:
        description: Display the transaction amount during card read.
        type: boolean
      fleet:
        $ref: '#/definitions/POST_Fleet_v1_refund'
        description: >-
          The fleet section that contains all applicable fleet. <a
          href='https://triposcert.vantiv.com/api/help/kb/fleet.html'>more&raquo;</a>
      getToken:
        description: >-
          To retrieve Token in the transaction. <a
          href='https://triposcert.vantiv.com/api/help/kb/GetToken.html'>more&raquo;</a>
        type: string
      giftCardProgram:
        description: >-
          This field is for Valutec gift/loyalty card program. <br>'01' =
          Original Gift Card Program <br>'02' = Promotional Gift Card Program
          <br>'03' = Original Combo Card Program <br>'04' = Auto Rewards LPR
          Card Program <br>'05' = Original Loyalty Card Program
        type: string
      giftProgramType:
        description: >-
          This field is for Valutec gift/loyalty card type. The value 0 is for
          gift and 1 for loyalty
        type: string
      invokeManualEntry:
        description: ' Invokes manual card entry.'
        type: boolean
      isCscSupported:
        description: >-
          Invokes prompt for cardholder to enter card security code for manual
          keyed card entry.
        type: string
      laneId:
        description: Specifies which lane to use.
        format: int32
        type: integer
      lodging:
        $ref: '#/definitions/POST_LodgingAuthorization_v1_refund'
        description: >-
          The lodging parameters to be passed in for a lodging transaction. <a
          href='https://triposcert.vantiv.com/api/help/kb/lodging.html'>more&raquo;</a>
      pinlessPosConversionIndicator:
        description: >-
          Flag indicating desire to convert Credit card Refund transaction to a
          PINless Debit Card transaction. <a
          href='https://triposcert.vantiv.com/api/help/kb/PinlessDebitConversion.html'>more&raquo;</a>
        type: string
      preRead:
        description: >-
          Flag indicating desire to process refund as PreRead (i.e. - do ONLY
          Pre-Read operations, then expecting next endpoint call to be
          QuickChip) <a
          href='https://triposcert.vantiv.com/api/help/kb/cloud/QuickChipConfiguration.html'>more&raquo;</a>.
        type: boolean
      preReadId:
        $ref: '#/definitions/POST_Guid_v1_refund'
        description: >-
          The preReadId returned in the pre-read response. This value should be
          a GUID.<a
          href='..\help\kb\QuickChipWithPreReadId.html'>more&raquo;</a>.
      quickChip:
        description: >-
          Flag indicating desire to process refund as QuickChip (i.e. - Pre-Read
          has been previously performed) <a
          href='https://triposcert.vantiv.com/api/help/kb/cloud/QuickChipConfiguration.html'>more&raquo;</a>.
        type: boolean
      referenceNumber:
        description: A user defined reference number.
        type: string
      salesTaxAmount:
        description: >-
          The amount of sales tax for the transaction. This is for Level II,
          submit amount for tax or 0.00 for tax-exempt.
        format: double
        type: number
      shiftId:
        description: An optional shift id for reference.
        type: string
      storeCard:
        $ref: '#/definitions/POST_StoreCard_v1_refund'
        description: Information necessary to process a StoreCard transaction.
      ticketNumber:
        description: An optional ticket number.
        type: string
      transactionAmount:
        description: >-
          The total transaction amount. This is the amount of funds to move on
          the card
        type: string
    required:
      - laneId
      - transactionAmount
  POST_ReloadGiftRequest_v1_gift_reload:
    description: ReloadGiftRequest
    properties:
      cardHolderPresentCode:
        description: >-
          Defines whether the cardholder is present at the transaction. This
          value is optional, but recommended to be set. If this value is not set
          in the request, it will be automatically set based on the market code.
        type: string
      clerkNumber:
        description: An optional clerk number for reference.
        type: string
      configuration:
        $ref: '#/definitions/POST_RequestConfiguration_v1_gift_reload'
        description: >-
          Any value included in this section will override the corresponding
          value set in the triPOS.config
      giftCardProgram:
        description: >-
          This field is for Valutec gift/loyalty card program. <br>'01' =
          Original Gift Card Program <br>'02' = Promotional Gift Card Program
          <br>'03' = Original Combo Card Program <br>'04' = Auto Rewards LPR
          Card Program <br>'05' = Original Loyalty Card Program
        type: string
      giftProgramType:
        description: >-
          This field is for Valutec gift/loyalty card type. The value 0 is for
          gift and 1 for loyalty
        type: string
      invokeManualEntry:
        description: ' Invokes manual card entry.'
        type: boolean
      isCscSupported:
        description: >-
          Invokes prompt for cardholder to enter card security code for manual
          keyed card entry.
        type: string
      laneId:
        description: Specifies which lane to use.
        format: int32
        type: integer
      referenceNumber:
        description: A user defined reference number.
        type: string
      shiftId:
        description: An optional shift id for reference.
        type: string
      storeCard:
        $ref: '#/definitions/POST_StoreCard_v1_gift_reload'
        description: Information necessary to process a StoreCard transaction.
      ticketNumber:
        description: An optional ticket number.
        type: string
      transactionAmount:
        description: >-
          The total transaction amount. This is the amount of funds to move on
          the card
        format: double
        type: number
    required:
      - laneId
      - transactionAmount
  POST_RequestConfiguration_v1_authorization_paymentAccountId:
    description: RequestConfiguration
    properties:
      allowPartialApprovals:
        description: 'If set to false, partial approvals are not allowed'
        type: boolean
      checkForDuplicateTransactions:
        description: >-
          If set to true, enables duplicate checking logic for the transaction
          at the host.
        type: boolean
      marketCode:
        description: 'The market code of the transaction. '
        type: string
  POST_RequestConfiguration_v1_authorization_token:
    description: RequestConfiguration
    properties:
      allowPartialApprovals:
        description: 'If set to false, partial approvals are not allowed'
        type: boolean
      checkForDuplicateTransactions:
        description: >-
          If set to true, enables duplicate checking logic for the transaction
          at the host.
        type: boolean
      marketCode:
        description: 'The market code of the transaction. '
        type: string
  POST_RequestConfiguration_v1_balance:
    description: RequestConfiguration
    properties:
      allowPartialApprovals:
        description: 'If set to false, partial approvals are not allowed'
        type: boolean
      checkForDuplicateTransactions:
        description: >-
          If set to true, enables duplicate checking logic for the transaction
          at the host.
        type: boolean
      marketCode:
        description: 'The market code of the transaction. '
        type: string
  POST_RequestConfiguration_v1_gift_activate:
    description: RequestConfiguration
    properties:
      allowPartialApprovals:
        description: 'If set to false, partial approvals are not allowed'
        type: boolean
      checkForDuplicateTransactions:
        description: >-
          If set to true, enables duplicate checking logic for the transaction
          at the host.
        type: boolean
      marketCode:
        description: 'The market code of the transaction. '
        type: string
  POST_RequestConfiguration_v1_gift_balanceTransfer:
    description: RequestConfiguration
    properties:
      allowPartialApprovals:
        description: 'If set to false, partial approvals are not allowed'
        type: boolean
      checkForDuplicateTransactions:
        description: >-
          If set to true, enables duplicate checking logic for the transaction
          at the host.
        type: boolean
      marketCode:
        description: 'The market code of the transaction. '
        type: string
  POST_RequestConfiguration_v1_gift_close:
    description: RequestConfiguration
    properties:
      allowPartialApprovals:
        description: 'If set to false, partial approvals are not allowed'
        type: boolean
      checkForDuplicateTransactions:
        description: >-
          If set to true, enables duplicate checking logic for the transaction
          at the host.
        type: boolean
      marketCode:
        description: 'The market code of the transaction. '
        type: string
  POST_RequestConfiguration_v1_gift_reload:
    description: RequestConfiguration
    properties:
      allowPartialApprovals:
        description: 'If set to false, partial approvals are not allowed'
        type: boolean
      checkForDuplicateTransactions:
        description: >-
          If set to true, enables duplicate checking logic for the transaction
          at the host.
        type: boolean
      marketCode:
        description: 'The market code of the transaction. '
        type: string
  POST_RequestConfiguration_v1_gift_unload:
    description: RequestConfiguration
    properties:
      allowPartialApprovals:
        description: 'If set to false, partial approvals are not allowed'
        type: boolean
      checkForDuplicateTransactions:
        description: >-
          If set to true, enables duplicate checking logic for the transaction
          at the host.
        type: boolean
      marketCode:
        description: 'The market code of the transaction. '
        type: string
  POST_RequestConfiguration_v1_refund_paymentAccountId:
    description: RequestConfiguration
    properties:
      allowPartialApprovals:
        description: 'If set to false, partial approvals are not allowed'
        type: boolean
      checkForDuplicateTransactions:
        description: >-
          If set to true, enables duplicate checking logic for the transaction
          at the host.
        type: boolean
      marketCode:
        description: 'The market code of the transaction. '
        type: string
  POST_RequestConfiguration_v1_refund_token:
    description: RequestConfiguration
    properties:
      allowPartialApprovals:
        description: 'If set to false, partial approvals are not allowed'
        type: boolean
      checkForDuplicateTransactions:
        description: >-
          If set to true, enables duplicate checking logic for the transaction
          at the host.
        type: boolean
      marketCode:
        description: 'The market code of the transaction. '
        type: string
  POST_RequestConfiguration_v1_sale_paymentAccountId:
    description: RequestConfiguration
    properties:
      allowPartialApprovals:
        description: 'If set to false, partial approvals are not allowed'
        type: boolean
      checkForDuplicateTransactions:
        description: >-
          If set to true, enables duplicate checking logic for the transaction
          at the host.
        type: boolean
      marketCode:
        description: 'The market code of the transaction. '
        type: string
  POST_RequestConfiguration_v1_sale_token:
    description: RequestConfiguration
    properties:
      allowPartialApprovals:
        description: 'If set to false, partial approvals are not allowed'
        type: boolean
      checkForDuplicateTransactions:
        description: >-
          If set to true, enables duplicate checking logic for the transaction
          at the host.
        type: boolean
      marketCode:
        description: 'The market code of the transaction. '
        type: string
  POST_ReturnRequestConfiguration_v1_return_transactionId_paymentType:
    description: ReturnRequestConfiguration
    properties:
      allowPartialApprovals:
        description: 'If set to false, partial approvals are not allowed'
        type: boolean
      checkForDuplicateTransactions:
        description: >-
          If set to true, enables duplicate checking logic for the transaction
          at the host.
        type: boolean
      marketCode:
        description: 'The market code of the transaction. '
        type: string
      promptForSignature:
        description: >-
          Specifies how the signature prompt should be handled for the request.
          If a value is not provided, Always will be used. See <a
          href='https://triposcert.vantiv.com/api/help/kb/signaturePrompt.html'>Signature Prompt</a>.
        type: string
  POST_ReturnRequestConfiguration_v1_sale_transactionId_return_paymentType:
    description: ReturnRequestConfiguration
    properties:
      allowPartialApprovals:
        description: 'If set to false, partial approvals are not allowed'
        type: boolean
      checkForDuplicateTransactions:
        description: >-
          If set to true, enables duplicate checking logic for the transaction
          at the host.
        type: boolean
      marketCode:
        description: 'The market code of the transaction. '
        type: string
      promptForSignature:
        description: >-
          Specifies how the signature prompt should be handled for the request.
          If a value is not provided, Always will be used. See <a
          href='https://triposcert.vantiv.com/api/help/kb/signaturePrompt.html'>Signature Prompt</a>.
        type: string
  POST_ReturnRequest_v1_return_transactionId_paymentType:
    description: ReturnRequest
    properties:
      address:
        $ref: '#/definitions/POST_Address_v1_return_transactionId_paymentType'
        description: The cardholder address information for the transaction.
      autoRental:
        $ref: '#/definitions/POST_AutoRentalBasic_v1_return_transactionId_paymentType'
        description: >-
          The auto rental parameters to be passed in for an auto rental
          transaction. <a href='https://triposcert.vantiv.com/api/help/kb/autorental.html'>more&raquo;</a>
      cardHolderPresentCode:
        description: >-
          Defines whether the cardholder is present at the transaction. This
          value is optional, but recommended to be set. If this value is not set
          in the request, it will be automatically set based on the market code.
        type: string
      clerkNumber:
        description: An optional clerk number for reference.
        type: string
      commercialCardCustomerCode:
        description: >-
          The commercial card customer code for the transaction. This is for
          Level II.
        type: string
      configuration:
        $ref: >-
          #/definitions/POST_ReturnRequestConfiguration_v1_return_transactionId_paymentType
        description: >-
          Any value included in this section will override the corresponding
          value set in the triPOS.config
      fleet:
        $ref: '#/definitions/POST_Fleet_v1_return_transactionId_paymentType'
        description: >-
          The fleet section that contains all applicable fleet. <a
          href='https://triposcert.vantiv.com/api/help/kb/fleet.html'>more&raquo;</a>
      giftCardProgram:
        description: >-
          This field is for Valutec gift/loyalty card program. <br>'01' =
          Original Gift Card Program <br>'02' = Promotional Gift Card Program
          <br>'03' = Original Combo Card Program <br>'04' = Auto Rewards LPR
          Card Program <br>'05' = Original Loyalty Card Program
        type: string
      giftProgramType:
        description: >-
          This field is for Valutec gift/loyalty card type. The value 0 is for
          gift and 1 for loyalty
        type: string
      laneId:
        description: Specifies which lane to use.
        format: int32
        type: integer
      lodging:
        $ref: >-
          #/definitions/POST_LodgingAuthorization_v1_return_transactionId_paymentType
        description: >-
          The lodging parameters to be passed in for a lodging transaction. <a
          href='https://triposcert.vantiv.com/api/help/kb/lodging.html'>more&raquo;</a>
      referenceNumber:
        description: A user defined reference number.
        type: string
      salesTaxAmount:
        description: >-
          The amount of sales tax for the transaction. This is for Level II,
          submit amount for tax or 0.00 for tax-exempt.
        format: double
        type: number
      shiftId:
        description: An optional shift id for reference.
        type: string
      storeCard:
        $ref: '#/definitions/POST_StoreCard_v1_return_transactionId_paymentType'
        description: Information necessary to process a StoreCard transaction.
      ticketNumber:
        description: An optional ticket number.
        type: string
      transactionAmount:
        description: >-
          The total transaction amount. This is the amount of funds to move on
          the card
        format: double
        type: number
    required:
      - laneId
      - transactionAmount
  POST_ReturnRequest_v1_sale_transactionId_return_paymentType:
    description: ReturnRequest
    properties:
      address:
        $ref: '#/definitions/POST_Address_v1_sale_transactionId_return_paymentType'
        description: The cardholder address information for the transaction.
      autoRental:
        $ref: >-
          #/definitions/POST_AutoRentalBasic_v1_sale_transactionId_return_paymentType
        description: >-
          The auto rental parameters to be passed in for an auto rental
          transaction. <a href='https://triposcert.vantiv.com/api/help/kb/autorental.html'>more&raquo;</a>
      cardHolderPresentCode:
        description: >-
          Defines whether the cardholder is present at the transaction. This
          value is optional, but recommended to be set. If this value is not set
          in the request, it will be automatically set based on the market code.
        type: string
      clerkNumber:
        description: An optional clerk number for reference.
        type: string
      commercialCardCustomerCode:
        description: >-
          The commercial card customer code for the transaction. This is for
          Level II.
        type: string
      configuration:
        $ref: >-
          #/definitions/POST_ReturnRequestConfiguration_v1_sale_transactionId_return_paymentType
        description: >-
          Any value included in this section will override the corresponding
          value set in the triPOS.config
      fleet:
        $ref: '#/definitions/POST_Fleet_v1_sale_transactionId_return_paymentType'
        description: >-
          The fleet section that contains all applicable fleet. <a
          href='https://triposcert.vantiv.com/api/help/kb/fleet.html'>more&raquo;</a>
      giftCardProgram:
        description: >-
          This field is for Valutec gift/loyalty card program. <br>'01' =
          Original Gift Card Program <br>'02' = Promotional Gift Card Program
          <br>'03' = Original Combo Card Program <br>'04' = Auto Rewards LPR
          Card Program <br>'05' = Original Loyalty Card Program
        type: string
      giftProgramType:
        description: >-
          This field is for Valutec gift/loyalty card type. The value 0 is for
          gift and 1 for loyalty
        type: string
      laneId:
        description: Specifies which lane to use.
        format: int32
        type: integer
      lodging:
        $ref: >-
          #/definitions/POST_LodgingAuthorization_v1_sale_transactionId_return_paymentType
        description: >-
          The lodging parameters to be passed in for a lodging transaction. <a
          href='https://triposcert.vantiv.com/api/help/kb/lodging.html'>more&raquo;</a>
      referenceNumber:
        description: A user defined reference number.
        type: string
      salesTaxAmount:
        description: >-
          The amount of sales tax for the transaction. This is for Level II,
          submit amount for tax or 0.00 for tax-exempt.
        format: double
        type: number
      shiftId:
        description: An optional shift id for reference.
        type: string
      storeCard:
        $ref: '#/definitions/POST_StoreCard_v1_sale_transactionId_return_paymentType'
        description: Information necessary to process a StoreCard transaction.
      ticketNumber:
        description: An optional ticket number.
        type: string
      transactionAmount:
        description: >-
          The total transaction amount. This is the amount of funds to move on
          the card
        format: double
        type: number
    required:
      - laneId
      - transactionAmount
  POST_ReversalRequest_v1_reversal_transactionId_paymentType:
    description: ReversalRequest
    properties:
      cardHolderPresentCode:
        description: >-
          Defines whether the cardholder is present at the transaction. This
          value is optional, but recommended to be set. If this value is not set
          in the request, it will be automatically set based on the market code.
        type: string
      clerkNumber:
        description: An optional clerk number for reference.
        type: string
      configuration:
        $ref: >-
          #/definitions/POST_TransactionIdRequestConfiguration_v1_reversal_transactionId_paymentType
        description: >-
          Any value included in this section will override the corresponding
          value set in the triPOS.config
      convenienceFeeAmount:
        description: The convenience fee amount.
        format: double
        type: number
      ebtType:
        description: >-
          EBT card type of the original transaction. This is required when
          payment type is EBT.
        type: string
      getToken:
        description: To retrieve Token in the transaction.
        type: string
      giftCardProgram:
        description: >-
          This field is for Valutec gift/loyalty card program. <br>'01' =
          Original Gift Card Program <br>'02' = Promotional Gift Card Program
          <br>'03' = Original Combo Card Program <br>'04' = Auto Rewards LPR
          Card Program <br>'05' = Original Loyalty Card Program
        type: string
      giftProgramType:
        description: >-
          This field is for Valutec gift/loyalty card type. The value 0 is for
          gift and 1 for loyalty
        type: string
      laneId:
        description: Specifies which lane to use.
        format: int32
        type: integer
      networkTransactionID:
        description: >-
          The card brand specific transaction ID that should be stored by the
          integrator.
        type: string
      recurringPaymentType:
        description: Intent of why the credentials are being stored.
        type: string
      referenceNumber:
        description: A user defined reference number.
        type: string
      shiftId:
        description: An optional shift id for reference.
        type: string
      storeCard:
        $ref: '#/definitions/POST_StoreCard_v1_reversal_transactionId_paymentType'
        description: Information necessary to process a StoreCard transaction.
      submissionType:
        description: Initial vs Subsequent Transaction.
        type: string
      ticketNumber:
        description: An optional ticket number.
        type: string
      transactionAmount:
        description: 'The original transaction amount. '
        format: double
        type: number
      type:
        description: The type of reversal.
        type: string
    required:
      - laneId
      - transactionAmount
  POST_SaleRequestConfiguration_v1_sale:
    description: SaleRequestConfiguration
    properties:
      allowDebit:
        description: >-
          Use this parameter to allow debit <a
          href='https://triposcert.vantiv.com/api/help/kb/allowDebit.html'>more&raquo;</a>.
        type: boolean
      allowPartialApprovals:
        description: 'If set to false, partial approvals are not allowed'
        type: boolean
      allowedPaymentTypes:
        description: >-
          Pass in either or both values. If a single value is passed then no AID
          option will be presented for cardholder to select and automatic AID
          selection will happen, assuming only one credit/debit AID is available
          on a card. In case, multiple credit AIDs or multiple debit AIDs are
          available on a card, then choice will be given to choose among the
          filtered list of credit/debit AIDs.<a
          href='https://triposcert.vantiv.com/api/help/kb/allowPaymentTypes.html'>more&raquo;</a>
        items:
          type: string
        type: array
      cardReadRetries:
        description: "Number of retries in case of bad card read. The\_default\_value\_is\_1."
        format: int32
        type: integer
      cashbackOptions:
        $ref: '#/definitions/POST_CashbackOptions_v1_sale'
        description: >-
          Use this section to specify cashback options for each request <a
          href='https://triposcert.vantiv.com/api/help/kb/cashbackOptions.html'>more&raquo;</a>.
      checkForDuplicateTransactions:
        description: >-
          If set to true, enables duplicate checking logic for the transaction
          at the host.
        type: boolean
      confirmOriginalAmount:
        description: >-
          Use this parameter to confirm the sale original amount <a
          href='https://triposcert.vantiv.com/api/help/kb/confirmOriginalAmount.html'>more&raquo;</a>.
        type: string
      isGiftSupported:
        description: Use this parameter to allow Vantiv & Valutec gift cards to be used.
        type: string
      isManualEntryAllowed:
        description: >-
          Use this parameter to allow manual entry of card account numbers on
          the PIN pad.
        type: string
      marketCode:
        description: 'The market code of the transaction. '
        type: string
      processUSMaestroDebitOffLinePinCvmAsDebit:
        description: >-
          Use this parameter to allow Maestro Debit Aids to be processed as
          Debit if the CVM is Offline PIN
        type: string
      promptForSignature:
        description: >-
          Specifies how the signature prompt should be handled for the request.
          If a value is not provided, UseThreshold will be used. See <a
          href='https://triposcert.vantiv.com/api/help/kb/signaturePrompt.html'>Signature Prompt</a>.
        type: string
      provisionalAmount:
        description: >-
          Override provisional amount used for QC transactions, which is $1.00
          by default
        type: string
      thresholdAmount:
        description: >-
          Specifies the threshold value to use. If included, will override the
          value in the triPOS.config when promptForSignature is UseThreshold.
          See <a href='https://triposcert.vantiv.com/api/help/kb/signaturePrompt.html'>Signature Prompt</a>.
        format: double
        type: number
      tipOptions:
        $ref: '#/definitions/POST_TipOptions_v1_sale'
        description: >-
          If these tip options are sent in, they will override the tip options
          that are currently set in the triPOS.config. To disable tip, send this
          section up with empty values. To use the values from the
          triPOS.config, do not include this section in your request <a
          href='https://triposcert.vantiv.com/api/help/kb/tipOptions.html'>more&raquo;</a>.
      userInputTimeout:
        description: Specifies the user input timeout.
        type: string
  POST_SaleRequest_v1_sale:
    description: SaleRequest
    properties:
      address:
        $ref: '#/definitions/POST_Address_v1_sale'
        description: The cardholder address information for the transaction.
      autoRental:
        $ref: '#/definitions/POST_AutoRental_v1_sale'
        description: >-
          The auto rental parameters to be passed in for an auto rental
          transaction. <a href='https://triposcert.vantiv.com/api/help/kb/autorental.html'>more&raquo;</a>
      cardHolderPresentCode:
        description: >-
          Defines whether the cardholder is present at the transaction. This
          value is optional, but recommended to be set. If this value is not set
          in the request, it will be automatically set based on the market code.
        type: string
      checkForPreReadId:
        description: >-
          Flag to support 'PreReadId feature in quick chip' transaction request.
          This will take precedence over triPOS.config flag.
        type: boolean
      clerkNumber:
        description: An optional clerk number for reference.
        type: string
      commercialCardCustomerCode:
        description: >-
          The commercial card customer code for the transaction. This is for
          Level II.
        type: string
      configuration:
        $ref: '#/definitions/POST_SaleRequestConfiguration_v1_sale'
        description: >-
          Any value included in this section will override the corresponding
          value set in the triPOS.config
      convenienceFeeAmount:
        description: >-
          The convenience fee amount of the transaction. This amount is added to
          the TotalAmount before the cardholder is charged. <a
          href='https://triposcert.vantiv.com/api/help/kb/convenienceFeeAmount.html'>more&raquo;</a>
        format: double
        type: number
      creditSurchargeAmount:
        description: >-
          The credit surcharge amount of the transaction. This amount is added
          to the TotalAmount before the cardholder is charged. <a
          href='https://triposcert.vantiv.com/api/help/kb/cloud/Surcharging.html'>more&raquo;</a>
        format: double
        type: number
      currencyCode:
        description: The currency code used in the transaction.
        type: string
      displayTransactionAmount:
        description: Display the transaction amount during card read.
        type: boolean
      ebtType:
        description: EbtType may be FoodStamp or CashBenefit
        type: string
      estimatedAmountIndicator:
        description: >-
          The EstimatedAmountIndicator can be used by merchants/integrators to
          define the TransactionAmount submitted to Express either as an
          Estimated Amount (i.e. amount to charge cardholder may change) or a
          Final Amount (i.e. amount to charge cardholder will not change).  It
          will be a 1-character request field supporting the following request
          settings:
        type: string
      fleet:
        $ref: '#/definitions/POST_Fleet_v1_sale'
        description: >-
          The fleet section that contains all applicable fleet. <a
          href='https://triposcert.vantiv.com/api/help/kb/fleet.html'>more&raquo;</a>
      foodStampAmount:
        description: >-
          If POS app sends FoodStampAmount, then replace OriginalAmount with
          FoodStampAmount for EBT FoodStamp transactions
        format: double
        type: number
      getToken:
        description: >-
          To retrieve Token in the transaction. <a
          href='https://triposcert.vantiv.com/api/help/kb/GetToken.html'>more&raquo;</a>
        type: string
      giftCardProgram:
        description: >-
          This field is for Valutec gift/loyalty card program. <br>'01' =
          Original Gift Card Program <br>'02' = Promotional Gift Card Program
          <br>'03' = Original Combo Card Program <br>'04' = Auto Rewards LPR
          Card Program <br>'05' = Original Loyalty Card Program
        type: string
      giftProgramType:
        description: >-
          This field is for Valutec gift/loyalty card type. The value 0 is for
          gift and 1 for loyalty
        type: string
      healthcare:
        $ref: '#/definitions/POST_Healthcare_v1_sale'
        description: >-
          The healthcare section that contains all applicable
          healthcare-qualified amounts. <a
          href='https://triposcert.vantiv.com/api/help/kb/healthcare.html'>more&raquo;</a>
      invokeManualEntry:
        description: Invoke manual entry card read.
        type: boolean
      isCscSupported:
        description: >-
          Invokes prompt for cardholder to enter card security code for manual
          keyed card entry.
        type: string
      laneId:
        description: Specifies which lane to use.
        format: int32
        type: integer
      lodging:
        $ref: '#/definitions/POST_LodgingTransactionCompletion_v1_sale'
        description: >-
          The lodging parameters to be passed in for a lodging transaction. <a
          href='https://triposcert.vantiv.com/api/help/kb/lodging.html'>more&raquo;</a>
      networkTransactionID:
        description: >-
          The card brand specific transaction ID that should be stored by the
          integrator.
        type: string
      nonFinancialExpected:
        description: >-
          Non Financial Card read Expected. Only supported on unattended
          devices.
        type: boolean
      pinlessPosConversionIndicator:
        description: >-
          Flag indicating desire to convert Credit card Sale transaction to a
          PINless Debit Card transaction. <a
          href='https://triposcert.vantiv.com/api/help/kb/PinlessDebitConversion.html'>more&raquo;</a>
        type: string
      preRead:
        description: >-
          Flag indicating desire to process sale as PreRead (i.e. - do ONLY
          Pre-Read operations, then expecting next endpoint call to be
          QuickChip) <a
          href='https://triposcert.vantiv.com/api/help/kb/cloud/QuickChipConfiguration.html'>more&raquo;</a>.
        type: boolean
      preReadId:
        $ref: '#/definitions/POST_Guid_v1_sale'
        description: >-
          The preReadId returned in the pre-read response. This value should be
          a GUID.<a
          href='..\help\kb\QuickChipWithPreReadId.html'>more&raquo;</a>.
      quickChip:
        description: >-
          Flag indicating desire to process sale as QuickChip (i.e. - Pre-Read
          has been previously performed) <a
          href='https://triposcert.vantiv.com/api/help/kb/cloud/QuickChipConfiguration.html'>more&raquo;</a>.
        type: boolean
      recurringPaymentType:
        description: Intent of why the credentials are being stored.
        type: string
      referenceNumber:
        description: A user defined reference number.
        type: string
      requestedCashbackAmount:
        description: >-
          The requested cashback amount of the transaction. If the card used is
          cashback capable, this amount will be added to the total amount of the
          transaction. If the card is not cashback capable, the transaction will
          decline. More information on <a
          href='https://triposcert.vantiv.com/api/help/kb/RequestedCashbackAmount.html'>RequestedCashbackAmount</a>
          here.
        format: double
        type: number
      salesTaxAmount:
        description: >-
          The amount of sales tax for the transaction. This is for Level II,
          submit amount for tax or 0.00 for tax-exempt.
        format: double
        type: number
      shiftId:
        description: An optional shift id for reference.
        type: string
      storeCard:
        $ref: '#/definitions/POST_StoreCard_v1_sale'
        description: Information necessary to process a StoreCard transaction.
      submissionType:
        description: Initial vs Subsequent Transaction.
        type: string
      ticketNumber:
        description: An optional ticket number.
        type: string
      tipAmount:
        description: >-
          The tip amount of the transaction. This amount is added to the
          TotalAmount before the cardholder is charged.
        format: double
        type: number
      transactionAmount:
        description: >-
          The total transaction amount. This is the amount of funds to move on
          the card
        type: string
    required:
      - laneId
      - transactionAmount
  POST_ScrollingDisplayRequest_v1_scrollingDisplay:
    description: ScrollingDisplayRequest
    properties:
      laneId:
        description: The lane ID.
        format: int32
        type: integer
      lineItem:
        description: >-
          The new text line to be added in the scrolling area of the PIN pad
          screen. It typically includes a description and the price of an
          individual item (i.e. Cookies... $3.99).
        type: string
      subtotal:
        description: The new subtotal of all the scanned items including the new line item.
        type: string
      tax:
        description: The tax value of the new subtotal.
        type: string
      total:
        description: The value of the new subtotal and tax.
        type: string
    required:
      - laneId
      - lineItem
      - subtotal
      - tax
      - total
  POST_StoreCard_v1_balance:
    description: StoreCard
    properties:
      Id:
        description: The ID of a StoreCard.
        type: string
      Password:
        description: The password of StoreCard.
        type: string
  POST_StoreCard_v1_credit:
    description: StoreCard
    properties:
      Id:
        description: The ID of a StoreCard.
        type: string
      Password:
        description: The password of StoreCard.
        type: string
  POST_StoreCard_v1_gift_activate:
    description: StoreCard
    properties:
      Id:
        description: The ID of a StoreCard.
        type: string
      Password:
        description: The password of StoreCard.
        type: string
  POST_StoreCard_v1_gift_balanceTransfer:
    description: StoreCard
    properties:
      Id:
        description: The ID of a StoreCard.
        type: string
      Password:
        description: The password of StoreCard.
        type: string
  POST_StoreCard_v1_gift_close:
    description: StoreCard
    properties:
      Id:
        description: The ID of a StoreCard.
        type: string
      Password:
        description: The password of StoreCard.
        type: string
  POST_StoreCard_v1_gift_reload:
    description: StoreCard
    properties:
      Id:
        description: The ID of a StoreCard.
        type: string
      Password:
        description: The password of StoreCard.
        type: string
  POST_StoreCard_v1_gift_unload:
    description: StoreCard
    properties:
      Id:
        description: The ID of a StoreCard.
        type: string
      Password:
        description: The password of StoreCard.
        type: string
  POST_StoreCard_v1_refund:
    description: StoreCard
    properties:
      Id:
        description: The ID of a StoreCard.
        type: string
      Password:
        description: The password of StoreCard.
        type: string
  POST_StoreCard_v1_return_transactionId_paymentType:
    description: StoreCard
    properties:
      Id:
        description: The ID of a StoreCard.
        type: string
      Password:
        description: The password of StoreCard.
        type: string
  POST_StoreCard_v1_reversal_transactionId_paymentType:
    description: StoreCard
    properties:
      Id:
        description: The ID of a StoreCard.
        type: string
      Password:
        description: The password of StoreCard.
        type: string
  POST_StoreCard_v1_sale:
    description: StoreCard
    properties:
      Id:
        description: The ID of a StoreCard.
        type: string
      Password:
        description: The password of StoreCard.
        type: string
  POST_StoreCard_v1_sale_transactionId_return_paymentType:
    description: StoreCard
    properties:
      Id:
        description: The ID of a StoreCard.
        type: string
      Password:
        description: The password of StoreCard.
        type: string
  POST_TipOptions_v1_sale:
    description: TipOptions
    properties:
      otherOption:
        description: Other option to show to select tip.
        type: string
      tipSelections:
        description: CSV tip amount selections.
        type: string
      type:
        description: >-
          Type of tip entry: Amount selection, Percentage selection, or Prompt
          for custom value entry. Note: The Prompt value overrides the
          otherOption and tipSelections, skipping directly to Tip Amount entry
          screen.
        type: string
  POST_TokenAuthorizationRequest_v1_authorization_token:
    description: TokenAuthorizationRequest
    properties:
      address:
        $ref: '#/definitions/POST_Address_v1_authorization_token'
        description: The cardholder address information for the transaction.
      autoRental:
        $ref: '#/definitions/POST_AutoRentalBasic_v1_authorization_token'
        description: >-
          The auto rental parameters to be passed in for an auto rental
          transaction. <a href='https://triposcert.vantiv.com/api/help/kb/autorental.html'>more&raquo;</a>
      cardLogo:
        description: The card logo of the card that the token represents.
        type: string
      clerkNumber:
        description: An optional clerk number for reference.
        type: string
      configuration:
        $ref: '#/definitions/POST_RequestConfiguration_v1_authorization_token'
        description: >-
          Any value included in this section will override the corresponding
          value set in the triPOS.config
      convenienceFeeAmount:
        description: >-
          The convenience fee amount of the transaction. This amount is added to
          the TotalAmount before the cardholder is charged
        format: double
        type: number
      creditSurchargeAmount:
        description: >-
          The credit surcharge amount of the transaction. This amount is added
          to the TotalAmount before the cardholder is charged
        format: double
        type: number
      estimatedAmountIndicator:
        description: >-
          The EstimatedAmountIndicator can be used by merchants/integrators to
          define the TransactionAmount submitted to Express either as an
          Estimated Amount (i.e. amount to charge cardholder may change) or a
          Final Amount (i.e. amount to charge cardholder will not change).  It
          will be a 1-character request field supporting the following request
          settings:
        type: string
      expirationMonth:
        description: >-
          The expiration month of the card the token represents. Although this
          is not required, it is recommended for fraud protection.
        type: string
      expirationYear:
        description: >-
          The expiration year of the card the token represents. Although this is
          not required, it is recommended for fraud protection.
        type: string
      healthcare:
        $ref: '#/definitions/POST_Healthcare_v1_authorization_token'
        description: >-
          The healthcare section that contains all applicable
          healthcare-qualified amounts. <a
          href='https://triposcert.vantiv.com/api/help/kb/healthcare.html'>more&raquo;</a>
      laneId:
        description: Specifies which lane to use for the card sale.
        format: int32
        type: integer
      referenceNumber:
        description: A user defined reference number.
        type: string
      shiftId:
        description: An optional shift id for reference.
        type: string
      ticketNumber:
        description: An optional ticket number.
        type: string
      tipAmount:
        description: >-
          The tip amount of the transaction. This amount is added to the
          TotalAmount before the cardholder is charged.
        format: double
        type: number
      tokenId:
        description: The token ID used for the sale.
        type: string
      tokenProvider:
        description: The type of token ID used for the sale.
        type: string
      transactionAmount:
        description: >-
          The total transaction amount. This is the amount of funds to move on
          the card
        format: double
        type: number
      vaultId:
        description: The Vault ID used to create the token.
        type: string
    required:
      - cardLogo
      - laneId
      - tokenId
      - tokenProvider
      - transactionAmount
      - vaultId
  POST_TokenRefundRequest_v1_refund_token:
    description: TokenRefundRequest
    properties:
      cardLogo:
        description: The card logo of the card that the token represents.
        type: string
      clerkNumber:
        description: An optional clerk number for reference.
        type: string
      configuration:
        $ref: '#/definitions/POST_RequestConfiguration_v1_refund_token'
        description: >-
          Any value included in this section will override the corresponding
          value set in the triPOS.config
      convenienceFeeAmount:
        description: >-
          The convenience fee amount of the transaction. This amount is added to
          the TotalAmount before the cardholder is charged
        format: double
        type: number
      expirationMonth:
        description: >-
          The expiration month of the card the token represents. Although this
          is not required, it is recommended for fraud protection.
        type: string
      expirationYear:
        description: >-
          The expiration year of the card the token represents. Although this is
          not required, it is recommended for fraud protection.
        type: string
      laneId:
        description: Specifies which lane to use for the card sale.
        format: int32
        type: integer
      referenceNumber:
        description: A user defined reference number.
        type: string
      shiftId:
        description: An optional shift id for reference.
        type: string
      ticketNumber:
        description: An optional ticket number.
        type: string
      tokenId:
        description: The token ID used for the sale.
        type: string
      tokenProvider:
        description: The type of token ID used for the sale.
        type: string
      transactionAmount:
        description: >-
          The total transaction amount. This is the amount of funds to move on
          the card
        format: double
        type: number
      vaultId:
        description: The Vault ID used to create the token.
        type: string
    required:
      - cardLogo
      - laneId
      - tokenId
      - tokenProvider
      - transactionAmount
      - vaultId
  POST_TokenRequestConfiguration_v1_paymentAccount:
    description: TokenRequestConfiguration
    properties:
      cardReadRetries:
        description: "Number of retries in case of bad card read. The\_default\_value\_is\_1."
        format: int32
        type: integer
  POST_TokenRequestConfiguration_v1_paymentAccount_credit:
    description: TokenRequestConfiguration
    properties:
      cardReadRetries:
        description: "Number of retries in case of bad card read. The\_default\_value\_is\_1."
        format: int32
        type: integer
  POST_TokenRequestConfiguration_v1_token_omni:
    description: TokenRequestConfiguration
    properties:
      cardReadRetries:
        description: "Number of retries in case of bad card read. The\_default\_value\_is\_1."
        format: int32
        type: integer
  POST_TokenRequestConfiguration_v1_token_paymetric:
    description: TokenRequestConfiguration
    properties:
      cardReadRetries:
        description: "Number of retries in case of bad card read. The\_default\_value\_is\_1."
        format: int32
        type: integer
  POST_TokenRequestConfiguration_v1_token_worldpay:
    description: TokenRequestConfiguration
    properties:
      cardReadRetries:
        description: "Number of retries in case of bad card read. The\_default\_value\_is\_1."
        format: int32
        type: integer
  POST_TokenSaleRequest_v1_sale_token:
    description: TokenSaleRequest
    properties:
      address:
        $ref: '#/definitions/POST_Address_v1_sale_token'
        description: The cardholder address information for the transaction.
      autoRental:
        $ref: '#/definitions/POST_AutoRental_v1_sale_token'
        description: >-
          The auto rental parameters to be passed in for an auto rental
          transaction. <a href='https://triposcert.vantiv.com/api/help/kb/autorental.html'>more&raquo;</a>
      cardLogo:
        description: The card logo of the card that the token represents.
        type: string
      clerkNumber:
        description: An optional clerk number for reference.
        type: string
      configuration:
        $ref: '#/definitions/POST_RequestConfiguration_v1_sale_token'
        description: >-
          Any value included in this section will override the corresponding
          value set in the triPOS.config
      convenienceFeeAmount:
        description: >-
          The convenience fee amount of the transaction. This amount is added to
          the TotalAmount before the cardholder is charged
        format: double
        type: number
      creditSurchargeAmount:
        description: >-
          The credit surcharge amount of the transaction. This amount is added
          to the TotalAmount before the cardholder is charged
        format: double
        type: number
      estimatedAmountIndicator:
        description: >-
          The EstimatedAmountIndicator can be used by merchants/integrators to
          define the TransactionAmount submitted to Express either as an
          Estimated Amount (i.e. amount to charge cardholder may change) or a
          Final Amount (i.e. amount to charge cardholder will not change).  It
          will be a 1-character request field supporting the following request
          settings:
        type: string
      expirationMonth:
        description: >-
          The expiration month of the card the token represents. Although this
          is not required, it is recommended for fraud protection.
        type: string
      expirationYear:
        description: >-
          The expiration year of the card the token represents. Although this is
          not required, it is recommended for fraud protection.
        type: string
      healthcare:
        $ref: '#/definitions/POST_Healthcare_v1_sale_token'
        description: >-
          The healthcare section that contains all applicable
          healthcare-qualified amounts. <a
          href='https://triposcert.vantiv.com/api/help/kb/healthcare.html'>more&raquo;</a>
      laneId:
        description: Specifies which lane to use for the card sale.
        format: int32
        type: integer
      referenceNumber:
        description: A user defined reference number.
        type: string
      shiftId:
        description: An optional shift id for reference.
        type: string
      ticketNumber:
        description: An optional ticket number.
        type: string
      tipAmount:
        description: >-
          The tip amount of the transaction. This amount is added to the
          TotalAmount before the cardholder is charged.
        format: double
        type: number
      tokenId:
        description: The token ID used for the sale.
        type: string
      tokenProvider:
        description: The type of token ID used for the sale.
        type: string
      transactionAmount:
        description: >-
          The total transaction amount. This is the amount of funds to move on
          the card
        format: double
        type: number
      vaultId:
        description: The Vault ID used to create the token.
        type: string
    required:
      - cardLogo
      - laneId
      - tokenId
      - tokenProvider
      - transactionAmount
      - vaultId
  POST_TransactionIdRequestConfiguration_v1_authorization_transactionId_incremental:
    description: TransactionIdRequestConfiguration
    properties:
      marketCode:
        description: 'The market code of the transaction. '
        type: string
  POST_TransactionIdRequestConfiguration_v1_reversal_transactionId_paymentType:
    description: TransactionIdRequestConfiguration
    properties:
      marketCode:
        description: 'The market code of the transaction. '
        type: string
  POST_TransactionIdRequestConfiguration_v1_void_transactionId:
    description: TransactionIdRequestConfiguration
    properties:
      marketCode:
        description: 'The market code of the transaction. '
        type: string
  POST_TransactionQueryRequest_v1_transactionQuery:
    description: TransactionQueryRequest
    properties:
      approvalNumber:
        description: Approval number
        type: string
      approvedAmount:
        description: Amount approved by the transaction.
        format: double
        type: number
      expressTransactionDate:
        description: Express transaction date formatted YYYMMDD
        type: string
      expressTransactionTime:
        description: Express transaction time formatted HHMMSS
        type: string
      hostBatchId:
        description: Unique host batch identifier
        type: string
      hostItemId:
        description: Unique host batch reference number
        type: string
      referenceNumber:
        description: A user defined reference number.
        type: string
      reverseOrder:
        description: Flag to query records in descending order
        type: string
      shiftId:
        description: An optional shift id for reference.
        type: string
      terminalId:
        description: Terminal identifier
        type: string
      trackingId:
        description: Internal transaction tracking identifier
        type: string
      transactionAmount:
        description: Transaction amount
        format: double
        type: number
      transactionDateTimeBegin:
        description: >-
          Begin date/time of transaction range. Required if TransactionID or
          TransactionSetupID is not included. Format "YYYY-MM-DD HH:MM:SS"
        type: string
      transactionDateTimeEnd:
        description: >-
          End date/time of transaction range. Required if TransactionID or
          TransactionSetupID is not included. Format "YYYY-MM-DD HH:MM:SS"
        type: string
      transactionId:
        description: TransactionID returned in original transaction.
        type: string
      transactionSetupId:
        description: Transaction setup ID
        type: string
      transactionStatusCode:
        description: Transaction status code
        type: string
      transactionType:
        description: Transaction type
        type: string
    required:
      - approvalNumber
      - referenceNumber
      - terminalId
      - transactionDateTimeBegin
      - transactionDateTimeEnd
      - transactionId
  POST_UnloadGiftRequest_v1_gift_unload:
    description: UnloadGiftRequest
    properties:
      cardHolderPresentCode:
        description: >-
          Defines whether the cardholder is present at the transaction. This
          value is optional, but recommended to be set. If this value is not set
          in the request, it will be automatically set based on the market code.
        type: string
      clerkNumber:
        description: An optional clerk number for reference.
        type: string
      configuration:
        $ref: '#/definitions/POST_RequestConfiguration_v1_gift_unload'
        description: >-
          Any value included in this section will override the corresponding
          value set in the triPOS.config
      invokeManualEntry:
        description: ' Invokes manual card entry.'
        type: boolean
      isCscSupported:
        description: >-
          Invokes prompt for cardholder to enter card security code for manual
          keyed card entry.
        type: string
      laneId:
        description: Specifies which lane to use.
        format: int32
        type: integer
      referenceNumber:
        description: A user defined reference number.
        type: string
      shiftId:
        description: An optional shift id for reference.
        type: string
      storeCard:
        $ref: '#/definitions/POST_StoreCard_v1_gift_unload'
        description: Information necessary to process a StoreCard transaction.
      ticketNumber:
        description: An optional ticket number.
        type: string
      transactionAmount:
        description: >-
          The total transaction amount. This is the amount of funds to move on
          the card
        format: double
        type: number
    required:
      - laneId
      - transactionAmount
  POST_VoidRequest_v1_void_transactionId:
    description: VoidRequest
    properties:
      cardHolderPresentCode:
        description: >-
          Defines whether the cardholder is present at the transaction. This
          value is optional, but recommended to be set. If this value is not set
          in the request, it will be automatically set based on the market code.
        type: string
      clerkNumber:
        description: An optional clerk number for reference.
        type: string
      configuration:
        $ref: >-
          #/definitions/POST_TransactionIdRequestConfiguration_v1_void_transactionId
        description: >-
          Any value included in this section will override the corresponding
          value set in the triPOS.config
      laneId:
        description: Specifies which lane to use.
        format: int32
        type: integer
      referenceNumber:
        description: A user defined reference number.
        type: string
      shiftId:
        description: An optional shift id for reference.
        type: string
      ticketNumber:
        description: An optional ticket number.
        type: string
    required:
      - laneId
  PUT_Address_v1_paymentAccount_paymentAccountId:
    description: Address
    properties:
      billingAddress1:
        description: The street address used for billing purposes.
        type: string
      billingAddress2:
        description: The street address used for billing purposes.
        type: string
      billingCity:
        description: The name of the city used for billing purposes.
        type: string
      billingEmail:
        description: The e-mail address used for billing purposes.
        type: string
      billingName:
        description: The name used for billing purposes.
        type: string
      billingPhone:
        description: >-
          The phone number used for billing purposes. The recommended format is
          (800)555-1212.
        type: string
      billingPostalCode:
        description: The postal code used for billing purposes.
        type: string
      billingState:
        description: >-
          The name of the state used for billing purposes. This value may be any
          2 character state code or the full state name.
        type: string
      shippingAddress1:
        description: The street address used for shipping purposes.
        type: string
      shippingAddress2:
        description: The street address used for shipping purposes.
        type: string
      shippingCity:
        description: The name of the city used for shipping purposes.
        type: string
      shippingEmail:
        description: The e-mail address used for shipping purposes.
        type: string
      shippingName:
        description: The name used for shipping purposes.
        type: string
      shippingPhone:
        description: >-
          The phone number used for shipping purposes. The recommended format is
          (800)555-1212
        type: string
      shippingPostalCode:
        description: The postal code used for shipping purposes.
        type: string
      shippingState:
        description: >-
          The name of the state used for shipping purposes. This value may be
          any 2 character state code or the full state name.
        type: string
  PUT_Address_v1_paymentAccount_paymentAccountId_credit:
    description: Address
    properties:
      billingAddress1:
        description: The street address used for billing purposes.
        type: string
      billingAddress2:
        description: The street address used for billing purposes.
        type: string
      billingCity:
        description: The name of the city used for billing purposes.
        type: string
      billingEmail:
        description: The e-mail address used for billing purposes.
        type: string
      billingName:
        description: The name used for billing purposes.
        type: string
      billingPhone:
        description: >-
          The phone number used for billing purposes. The recommended format is
          (800)555-1212.
        type: string
      billingPostalCode:
        description: The postal code used for billing purposes.
        type: string
      billingState:
        description: >-
          The name of the state used for billing purposes. This value may be any
          2 character state code or the full state name.
        type: string
      shippingAddress1:
        description: The street address used for shipping purposes.
        type: string
      shippingAddress2:
        description: The street address used for shipping purposes.
        type: string
      shippingCity:
        description: The name of the city used for shipping purposes.
        type: string
      shippingEmail:
        description: The e-mail address used for shipping purposes.
        type: string
      shippingName:
        description: The name used for shipping purposes.
        type: string
      shippingPhone:
        description: >-
          The phone number used for shipping purposes. The recommended format is
          (800)555-1212
        type: string
      shippingPostalCode:
        description: The postal code used for shipping purposes.
        type: string
      shippingState:
        description: >-
          The name of the state used for shipping purposes. This value may be
          any 2 character state code or the full state name.
        type: string
  PUT_Nullable_Boolean_v1_paymentAccount_paymentAccountId:
    description: Nullable`Boolean`
    properties:
      hasValue:
        type: boolean
      value:
        type: boolean
    required:
      - hasValue
      - value
  PUT_Nullable_Boolean_v1_paymentAccount_paymentAccountId_credit:
    description: Nullable`Boolean`
    properties:
      hasValue:
        type: boolean
      value:
        type: boolean
    required:
      - hasValue
      - value
  PUT_Nullable_Int32_v1_paymentAccount_paymentAccountId:
    description: Nullable`Int32`
    properties:
      hasValue:
        type: boolean
      value:
        format: int32
        type: integer
    required:
      - hasValue
      - value
  PUT_Nullable_Int32_v1_paymentAccount_paymentAccountId_credit:
    description: Nullable`Int32`
    properties:
      hasValue:
        type: boolean
      value:
        format: int32
        type: integer
    required:
      - hasValue
      - value
  PUT_TokenRequestConfiguration_v1_paymentAccount_paymentAccountId:
    description: TokenRequestConfiguration
    properties:
      cardReadRetries:
        description: "Number of retries in case of bad card read. The\_default\_value\_is\_1."
        format: int32
        type: integer
  PUT_TokenRequestConfiguration_v1_paymentAccount_paymentAccountId_credit:
    description: TokenRequestConfiguration
    properties:
      cardReadRetries:
        description: "Number of retries in case of bad card read. The\_default\_value\_is\_1."
        format: int32
        type: integer
  PUT_UpdatePaymentAccountCreditRequest_v1_paymentAccount_paymentAccountId:
    description: UpdatePaymentAccountCreditRequest
    properties:
      address:
        $ref: '#/definitions/PUT_Address_v1_paymentAccount_paymentAccountId'
        description: The cardholder address information for the transaction.
      configuration:
        $ref: >-
          #/definitions/PUT_TokenRequestConfiguration_v1_paymentAccount_paymentAccountId
        description: >-
          Any value included in this section will override the corresponding
          value set in the triPOS.config
      expirationMonth:
        description: The expiration month.
        type: string
      expirationYear:
        description: The expiration year.
        type: string
      invokeManualEntry:
        description: ' Invokes manual card entry.'
        type: boolean
      laneId:
        description: The Lane ID.
        format: int32
        type: integer
      paymentAccountReferenceNumber:
        description: The payment account reference number
        type: string
      updateCardData:
        description: >-
          The value that is passed in for UpdateCardData. Should be true or
          false.
        type: boolean
    required:
      - laneId
      - paymentAccountReferenceNumber
      - updateCardData
  PUT_UpdatePaymentAccountCreditRequest_v1_paymentAccount_paymentAccountId_credit:
    description: UpdatePaymentAccountCreditRequest
    properties:
      address:
        $ref: '#/definitions/PUT_Address_v1_paymentAccount_paymentAccountId_credit'
        description: The cardholder address information for the transaction.
      configuration:
        $ref: >-
          #/definitions/PUT_TokenRequestConfiguration_v1_paymentAccount_paymentAccountId_credit
        description: >-
          Any value included in this section will override the corresponding
          value set in the triPOS.config
      expirationMonth:
        description: The expiration month.
        type: string
      expirationYear:
        description: The expiration year.
        type: string
      invokeManualEntry:
        description: ' Invokes manual card entry.'
        type: boolean
      laneId:
        description: The Lane ID.
        format: int32
        type: integer
      paymentAccountReferenceNumber:
        description: The payment account reference number
        type: string
      updateCardData:
        description: >-
          The value that is passed in for UpdateCardData. Should be true or
          false.
        type: boolean
    required:
      - laneId
      - paymentAccountReferenceNumber
      - updateCardData
  PaymentAccountAuthorizationRequest:
    description: PaymentAccountAuthorizationRequest
    properties:
      address:
        $ref: '#/definitions/POST_Address_v1_authorization_paymentAccountId'
        description: The cardholder address information for the transaction.
      clerkNumber:
        description: An optional clerk number for reference.
        type: string
      configuration:
        $ref: >-
          #/definitions/POST_RequestConfiguration_v1_authorization_paymentAccountId
        description: >-
          Any value included in this section will override the corresponding
          value set in the triPOS.config
      convenienceFeeAmount:
        description: >-
          The convenience fee amount of the transaction. This amount is added to
          the TotalAmount before the cardholder is charged
        format: double
        type: number
      creditSurchargeAmount:
        description: >-
          The credit surcharge amount of the transaction. This amount is added
          to the TotalAmount before the cardholder is charged
        format: double
        type: number
      healthcare:
        $ref: '#/definitions/POST_Healthcare_v1_authorization_paymentAccountId'
        description: >-
          The healthcare section that contains all applicable
          healthcare-qualified amounts. <a
          href='https://triposcert.vantiv.com/api/help/kb/healthcare.html'>more&raquo;</a>
      laneId:
        description: Specifies which lane to use for the card sale.
        format: int32
        type: integer
      referenceNumber:
        description: A user defined reference number.
        type: string
      shiftId:
        description: An optional shift id for reference.
        type: string
      ticketNumber:
        description: An optional ticket number.
        type: string
      tipAmount:
        description: >-
          The tip amount of the transaction. This amount is added to the
          TotalAmount before the cardholder is charged.
        format: double
        type: number
      transactionAmount:
        description: >-
          The total transaction amount. This is the amount of funds to move on
          the card
        format: double
        type: number
    required:
      - laneId
      - transactionAmount
  PaymentAccountAuthorizationResponse:
    description: PaymentAccountAuthorizationResponse
    properties:
      _errors:
        description: A list of errors that occurred.
        items:
          $ref: '#/definitions/ApiError'
        type: array
      _hasErrors:
        description: Indicates if there are errors.
        type: boolean
      _links:
        description: A list of resource links
        items:
          $ref: '#/definitions/ApiLink'
        type: array
      _logs:
        description: >-
          A list of log entries detailing what happened during the request.
          Ideally only used during development or troubleshooting as this can be
          quite verbose.
        items:
          type: string
        type: array
      _processor:
        $ref: '#/definitions/Processor'
        description: Response information from the processor.
      _type:
        description: The type of object held in the result.
        type: string
      _warnings:
        description: A list of warnings that occurred.
        items:
          $ref: '#/definitions/ApiWarning'
        type: array
      approvalNumber:
        description: >-
          Approval number from the processor. Depending on card type and
          processor an approval number might not be returned.
        type: string
      approvedAmount:
        description: >-
          The amount approved by the processor. This is the actual amount that
          will be charged or credited.
        format: double
        type: number
      avsResponseCode:
        description: The AVS response code.
        type: string
      cardLogo:
        description: >-
          The card logo. Possible values are: Visa, Mastercard, Discover, Amex,
          Diners Club, JCB, Carte Blanche, Other.
        type: string
      convenienceFeeAmount:
        description: The convenience fee added to the transaction
        format: double
        type: number
      creditSurchargeAmount:
        description: The credit surcharge added to the transaction
        format: double
        type: number
      isApproved:
        description: Set to true if the host approved the transaction.
        type: boolean
      isOffline:
        description: >-
          A boolean value indicating whether triPOS is disconnected from the
          host.
        type: boolean
      merchantId:
        description: The Merchant used to process the transaction.
        type: string
      paymentAccountId:
        description: The payment account ID.
        type: string
      paymentAccountReferenceNumber:
        description: The payment account reference number.
        type: string
      referenceNumber:
        description: The reference number.
        type: string
      statusCode:
        description: The status code for the transaction.
        type: string
      subTotalAmount:
        description: The original amount sent for the transaction.
        format: double
        type: number
      terminalId:
        description: The ID of the terminal used during the transaction
        type: string
      tipAmount:
        description: The tip amount added to the transaction.
        format: double
        type: number
      totalAmount:
        description: The total amount of the transaction.
        format: double
        type: number
      transactionDateTime:
        description: Transaction date/time in ISO8601 format
        type: string
      transactionId:
        description: The transaction ID from the processor
        type: string
  PaymentAccountRefundRequest:
    description: PaymentAccountRefundRequest
    properties:
      clerkNumber:
        description: An optional clerk number for reference.
        type: string
      configuration:
        $ref: '#/definitions/POST_RequestConfiguration_v1_refund_paymentAccountId'
        description: >-
          Any value included in this section will override the corresponding
          value set in the triPOS.config
      convenienceFeeAmount:
        description: >-
          The convenience fee amount of the transaction. This amount is added to
          the TotalAmount before the cardholder is charged
        format: double
        type: number
      laneId:
        description: Specifies which lane to use for the card sale.
        format: int32
        type: integer
      referenceNumber:
        description: A user defined reference number.
        type: string
      shiftId:
        description: An optional shift id for reference.
        type: string
      ticketNumber:
        description: An optional ticket number.
        type: string
      transactionAmount:
        description: >-
          The total transaction amount. This is the amount of funds to move on
          the card
        format: double
        type: number
    required:
      - laneId
      - transactionAmount
  PaymentAccountRefundResponse:
    description: PaymentAccountRefundResponse
    properties:
      _errors:
        description: A list of errors that occurred.
        items:
          $ref: '#/definitions/ApiError'
        type: array
      _hasErrors:
        description: Indicates if there are errors.
        type: boolean
      _links:
        description: A list of resource links
        items:
          $ref: '#/definitions/ApiLink'
        type: array
      _logs:
        description: >-
          A list of log entries detailing what happened during the request.
          Ideally only used during development or troubleshooting as this can be
          quite verbose.
        items:
          type: string
        type: array
      _processor:
        $ref: '#/definitions/Processor'
        description: Response information from the processor.
      _type:
        description: The type of object held in the result.
        type: string
      _warnings:
        description: A list of warnings that occurred.
        items:
          $ref: '#/definitions/ApiWarning'
        type: array
      approvalNumber:
        description: >-
          Approval number from the processor. Depending on card type and
          processor an approval number might not be returned.
        type: string
      cardLogo:
        description: >-
          The card logo. Possible values are: Visa, Mastercard, Discover, Amex,
          Diners Club, JCB, Carte Blanche, Other.
        type: string
      convenienceFeeAmount:
        description: The convenience fee added to the transaction
        format: double
        type: number
      isApproved:
        description: Set to true if the host approved the transaction.
        type: boolean
      isOffline:
        description: >-
          A boolean value indicating whether triPOS is disconnected from the
          host.
        type: boolean
      merchantId:
        description: The Merchant used to process the transaction.
        type: string
      paymentAccountId:
        description: The payment account ID.
        type: string
      paymentAccountReferenceNumber:
        description: The payment account reference number.
        type: string
      referenceNumber:
        description: The reference number.
        type: string
      statusCode:
        description: The status code for the transaction.
        type: string
      terminalId:
        description: The ID of the terminal used during the transaction
        type: string
      totalAmount:
        description: The total amount of the transaction.
        format: double
        type: number
      transactionDateTime:
        description: Transaction date/time in ISO8601 format
        type: string
      transactionId:
        description: The transaction ID from the processor
        type: string
  PaymentAccountSaleRequest:
    description: PaymentAccountSaleRequest
    properties:
      address:
        $ref: '#/definitions/POST_Address_v1_sale_paymentAccountId'
        description: The cardholder address information for the transaction.
      clerkNumber:
        description: An optional clerk number for reference.
        type: string
      configuration:
        $ref: '#/definitions/POST_RequestConfiguration_v1_sale_paymentAccountId'
        description: >-
          Any value included in this section will override the corresponding
          value set in the triPOS.config
      convenienceFeeAmount:
        description: >-
          The convenience fee amount of the transaction. This amount is added to
          the TotalAmount before the cardholder is charged
        format: double
        type: number
      creditSurchargeAmount:
        description: >-
          The credit surcharge amount of the transaction. This amount is added
          to the TotalAmount before the cardholder is charged
        format: double
        type: number
      healthcare:
        $ref: '#/definitions/POST_Healthcare_v1_sale_paymentAccountId'
        description: >-
          The healthcare section that contains all applicable
          healthcare-qualified amounts. <a
          href='https://triposcert.vantiv.com/api/help/kb/healthcare.html'>more&raquo;</a>
      laneId:
        description: Specifies which lane to use for the card sale.
        format: int32
        type: integer
      referenceNumber:
        description: A user defined reference number.
        type: string
      shiftId:
        description: An optional shift id for reference.
        type: string
      ticketNumber:
        description: An optional ticket number.
        type: string
      tipAmount:
        description: >-
          The tip amount of the transaction. This amount is added to the
          TotalAmount before the cardholder is charged.
        format: double
        type: number
      transactionAmount:
        description: >-
          The total transaction amount. This is the amount of funds to move on
          the card
        format: double
        type: number
    required:
      - laneId
      - transactionAmount
  PaymentAccountSaleResponse:
    description: PaymentAccountSaleResponse
    properties:
      _errors:
        description: A list of errors that occurred.
        items:
          $ref: '#/definitions/ApiError'
        type: array
      _hasErrors:
        description: Indicates if there are errors.
        type: boolean
      _links:
        description: A list of resource links
        items:
          $ref: '#/definitions/ApiLink'
        type: array
      _logs:
        description: >-
          A list of log entries detailing what happened during the request.
          Ideally only used during development or troubleshooting as this can be
          quite verbose.
        items:
          type: string
        type: array
      _processor:
        $ref: '#/definitions/Processor'
        description: Response information from the processor.
      _type:
        description: The type of object held in the result.
        type: string
      _warnings:
        description: A list of warnings that occurred.
        items:
          $ref: '#/definitions/ApiWarning'
        type: array
      approvalNumber:
        description: >-
          Approval number from the processor. Depending on card type and
          processor an approval number might not be returned.
        type: string
      approvedAmount:
        description: >-
          The amount approved by the processor. This is the actual amount that
          will be charged or credited.
        format: double
        type: number
      avsResponseCode:
        description: The AVS response code.
        type: string
      cardLogo:
        description: >-
          The card logo. Possible values are: Visa, Mastercard, Discover, Amex,
          Diners Club, JCB, Carte Blanche, Other.
        type: string
      convenienceFeeAmount:
        description: The convenience fee added to the transaction
        format: double
        type: number
      creditSurchargeAmount:
        description: The credit surcharge added to the transaction
        format: double
        type: number
      isApproved:
        description: Set to true if the host approved the transaction.
        type: boolean
      isOffline:
        description: >-
          A boolean value indicating whether triPOS is disconnected from the
          host.
        type: boolean
      merchantId:
        description: The Merchant used to process the transaction.
        type: string
      paymentAccountId:
        description: The payment account ID.
        type: string
      paymentAccountReferenceNumber:
        description: The payment account reference number.
        type: string
      referenceNumber:
        description: The reference number.
        type: string
      statusCode:
        description: The status code for the transaction.
        type: string
      subTotalAmount:
        description: The original amount sent for the transaction.
        format: double
        type: number
      terminalId:
        description: The ID of the terminal used during the transaction
        type: string
      tipAmount:
        description: The tip amount added to the transaction.
        format: double
        type: number
      totalAmount:
        description: The total amount of the transaction.
        format: double
        type: number
      transactionDateTime:
        description: Transaction date/time in ISO8601 format
        type: string
      transactionId:
        description: The transaction ID from the processor
        type: string
  PinPadSelectionRequest:
    description: PinPadSelectionRequest
  PinPadSelectionResponse:
    description: PinPadSelectionResponse
    properties:
      _errors:
        description: A list of errors that occurred.
        items:
          $ref: '#/definitions/ApiError'
        type: array
      _hasErrors:
        description: Indicates if there are errors.
        type: boolean
      _links:
        description: A list of resource links
        items:
          $ref: '#/definitions/ApiLink'
        type: array
      _logs:
        description: >-
          A list of log entries detailing what happened during the request.
          Ideally only used during development or troubleshooting as this can be
          quite verbose.
        items:
          type: string
        type: array
      _type:
        description: The type of object held in the result.
        type: string
      _warnings:
        description: A list of warnings that occurred.
        items:
          $ref: '#/definitions/ApiWarning'
        type: array
      selectionIndex:
        description: >-
          The zero-based index of the option that the cardholder selected. The
          first option you pass in will be considered option 0.
        format: int32
        type: integer
  Processor:
    description: Processor
    properties:
      expressResponseCode:
        description: The response code received from Express.
        type: string
      expressResponseMessage:
        description: The response message received from Express.
        type: string
      hostResponseCode:
        description: >-
          The response code received from the host via Express. NOTE: This value
          is only populated if Express send the request to the host.
        type: string
      hostResponseMessage:
        description: >-
          The response message received from the host via Express. NOTE: This
          value is only populated if Express send the request to the host.
        type: string
      logs:
        description: A list of messages pertaining processing the transaction.
        items:
          type: string
        type: array
      processorLogs:
        description: '[DEPRECATED] Use logs.'
        items:
          type: string
        type: array
      processorName:
        type: string
      processorRawResponse:
        description: '[DEPRECATED] Use rawResponse.'
        type: string
      processorReferenceNumber:
        description: '[DEPRECATED] Use the same reference number passed in the request.'
        type: string
      processorRequestFailed:
        description: '[DEPRECATED] Use top level properties (e.g. hasErrors).'
        type: boolean
      processorRequestWasApproved:
        description: '[DEPRECATED] Use top level properties (e.g isApproved).'
        type: boolean
      processorResponseCode:
        description: '[DEPRECATED] Use expressResponseCode.'
        type: string
      processorResponseMessage:
        description: '[DEPRECATED] Use expressResponseMessage.'
        type: string
      rawRequest:
        type: string
      rawResponse:
        description: >-
          The raw processor response. In the case of Express, this is the raw
          XML returned by the Express platform.
        type: string
  RebootLaneRequest:
    description: RebootLaneRequest
    properties:
      laneId:
        description: >-
          The desired lane ID. The lane ID should be a maximum of six digits
          long.
        format: int32
        type: integer
    required:
      - laneId
  RebootLaneResponse:
    description: RebootLaneResponse
    properties:
      _errors:
        description: A list of errors that occurred.
        items:
          $ref: '#/definitions/ApiError'
        type: array
      _hasErrors:
        description: Indicates if there are errors.
        type: boolean
      _links:
        description: A list of resource links
        items:
          $ref: '#/definitions/ApiLink'
        type: array
      _logs:
        description: >-
          A list of log entries detailing what happened during the request.
          Ideally only used during development or troubleshooting as this can be
          quite verbose.
        items:
          type: string
        type: array
      _type:
        description: The type of object held in the result.
        type: string
      _warnings:
        description: A list of warnings that occurred.
        items:
          $ref: '#/definitions/ApiWarning'
        type: array
  ReceiptEmvDto:
    description: ReceiptEmvDto
    properties:
      tags:
        description: >-
          A name value collection of additional EMV tags that are required to
          appear on the receipt.
        items:
          $ref: '#/definitions/POST_EmvTagKeyValue_v1_receipt'
        type: array
      applicationIdentifier:
        description: >-
          The Application Identifier also known as the AID. Identifies the
          application as described in ISO/IEC 7816-5. Printed receipts are
          required to contain the AID as hexadecimal characters.
        type: string
      applicationLabel:
        description: >-
          Mnemonic associated with the AID according to ISO/IEC 7816-5. If the
          Application Preferred Name is not available or the Issuer code table
          index is not supported, then the Application Label should be used on
          the receipt instead of the Application Preferred Name.
        type: string
      applicationPreferredName:
        description: >-
          Preferred mnemonic associated with the AID. When the Application
          Preferred Name is present and the Issuer code table index is
          supported, then this data element is mandatory on the receipt.
        type: string
      cryptogram:
        description: >-
          The EMV cryptogram type and value. It is a preferred best practice to
          include this data element on the receipt, but is not mandatory. This
          field contains cryptogram type followed by the cryptogram value.
        type: string
      issuerCodeTableIndex:
        description: >-
          Indicates the code table according to ISO/IEC 8859 for displaying the
          Application Preferred Name.
        type: string
    required:
      - applicationIdentifier
      - applicationLabel
      - applicationPreferredName
      - cryptogram
      - issuerCodeTableIndex
      - tags
  ReceiptFleetDto:
    description: ReceiptFleetDto
    properties:
      additionalPromptedData1:
        description: Additional prompted data 1 for the fleet transaction.
        type: string
      additionalPromptedData2:
        description: Additional prompted data 2 for the fleet transaction.
        type: string
      driverId:
        description: The driver ID for the fleet transaction.
        type: string
      employeeNumber:
        description: The employee number for the fleet transaction.
        type: string
      jobNumber:
        description: The Job number/Purchase/Work Order for the fleet transaction.
        type: string
      odometer:
        description: The odometer reading for the fleet transaction.
        type: string
      trailerNumber:
        description: The trailer number for the fleet transaction.
        type: string
      userId:
        description: The user ID for the fleet transaction.
        type: string
      vehicleId:
        description: The vehicle ID for the fleet transaction.
        type: string
    required:
      - additionalPromptedData1
      - additionalPromptedData2
      - driverId
      - employeeNumber
      - jobNumber
      - odometer
      - trailerNumber
      - userId
      - vehicleId
  ReceiptRequest:
    description: ReceiptRequest
    properties:
      accountNumber:
        description: The card account number used in the transaction.
        type: string
      accountType:
        description: The Account Type Checking/Savings used in the transaction.
        type: string
      approvalNumber:
        description: Approval number of the transaction.
        type: string
      cardHolderName:
        description: The cardholder name used in the transaction.
        type: string
      cardLogo:
        description: The card logo of the card used in the transaction.
        type: string
      cashbackAmount:
        description: Cashback amount the customer received.
        format: double
        type: number
      copyType:
        description: Indicates whether the receipt is a Merchant Copy or a Customer Copy.
        type: string
      countryCode:
        description: The country code used in the transaction.
        type: string
      currencyCode:
        description: The currency code used in the transaction.
        type: string
      customTemplate:
        description: A custom template that should be used instead of the default.
        type: string
      emv:
        $ref: '#/definitions/POST_ReceiptEmvDto_v1_receipt'
        description: The EMV information of the EMV card used in the transaction.
      entryMode:
        description: 'Entry method used to enter card information, swipe, chip, etc.'
        type: string
      fleet:
        $ref: '#/definitions/POST_ReceiptFleetDto_v1_receipt'
        description: The Fleet information of the Fleet card used in the transaction.
      footer:
        description: >-
          The list of individual lines of text to be displayed at the bottom of
          the receipt.
        items:
          type: string
        type: array
      header:
        description: >-
          The list of individual lines of text to be displayed at the top of the
          receipt.
        items:
          type: string
        type: array
      hostResponseCode:
        description: The code returned by the transaction's processing host.
        type: string
      isApproved:
        description: Indicates whether the transaction was approved.
        type: boolean
      laneId:
        description: The lane ID.
        format: int32
        type: integer
      language:
        description: The language used in the transaction.
        type: string
      pinVerified:
        description: Indicates whether the entered PIN was verified.
        type: boolean
      receiptType:
        description: The type of receipt.
        type: string
      referenceNumber:
        description: The transaction's reference number.
        type: string
      subTotalAmount:
        description: The subtotal amount of the transaction.
        format: double
        type: number
      surchargeAmount:
        description: The surcharge amount.
        format: double
        type: number
      terminalId:
        description: The ID of the terminal used in the transaction.
        type: string
      tipAmount:
        description: The tip amount.
        format: double
        type: number
      totalAmount:
        description: The total amount of the transaction.
        format: double
        type: number
      transactionDateTime:
        description: Date and time of the transaction.
        type: string
      transactionId:
        description: The ID of the transaction.
        type: string
    required:
      - accountNumber
      - cardLogo
      - entryMode
      - isApproved
      - laneId
      - referenceNumber
      - subTotalAmount
      - terminalId
      - transactionDateTime
  ReceiptResponse:
    description: ReceiptResponse
    properties:
      _errors:
        description: A list of errors that occurred.
        items:
          $ref: '#/definitions/ApiError'
        type: array
      _hasErrors:
        description: Indicates if there are errors.
        type: boolean
      _links:
        description: A list of resource links
        items:
          $ref: '#/definitions/ApiLink'
        type: array
      _logs:
        description: >-
          A list of log entries detailing what happened during the request.
          Ideally only used during development or troubleshooting as this can be
          quite verbose.
        items:
          type: string
        type: array
      _type:
        description: The type of object held in the result.
        type: string
      _warnings:
        description: A list of warnings that occurred.
        items:
          $ref: '#/definitions/ApiWarning'
        type: array
      laneId:
        description: The lane ID.
        format: int32
        type: integer
      printResult:
        description: >-
          The result of the print operation is returned in the
          <code>printResult</code> field.
        type: string
  RefundRequest:
    description: RefundRequest
    properties:
      address:
        $ref: '#/definitions/POST_Address_v1_refund'
        description: The cardholder address information for the transaction.
      autoRental:
        $ref: '#/definitions/POST_AutoRentalBasic_v1_refund'
        description: >-
          The auto rental parameters to be passed in for an auto rental
          transaction. <a href='https://triposcert.vantiv.com/api/help/kb/autorental.html'>more&raquo;</a>
      cardHolderPresentCode:
        description: >-
          Defines whether the cardholder is present at the transaction. This
          value is optional, but recommended to be set. If this value is not set
          in the request, it will be automatically set based on the market code.
        type: string
      checkForPreReadId:
        description: >-
          Flag to support 'PreReadId feature in quick chip' transaction request.
          This will take precedence over triPOS.config flag.
        type: boolean
      clerkNumber:
        description: An optional clerk number for reference.
        type: string
      commercialCardCustomerCode:
        description: >-
          The commercial card customer code for the transaction. This is for
          Level II.
        type: string
      configuration:
        $ref: '#/definitions/POST_RefundRequestConfiguration_v1_refund'
        description: >-
          Any value included in this section will override the corresponding
          value set in the triPOS.config
      convenienceFeeAmount:
        description: The convenience fee amount.
        format: double
        type: number
      displayTransactionAmount:
        description: Display the transaction amount during card read.
        type: boolean
      fleet:
        $ref: '#/definitions/POST_Fleet_v1_refund'
        description: >-
          The fleet section that contains all applicable fleet. <a
          href='https://triposcert.vantiv.com/api/help/kb/fleet.html'>more&raquo;</a>
      getToken:
        description: >-
          To retrieve Token in the transaction. <a
          href='https://triposcert.vantiv.com/api/help/kb/GetToken.html'>more&raquo;</a>
        type: string
      giftCardProgram:
        description: >-
          This field is for Valutec gift/loyalty card program. <br>'01' =
          Original Gift Card Program <br>'02' = Promotional Gift Card Program
          <br>'03' = Original Combo Card Program <br>'04' = Auto Rewards LPR
          Card Program <br>'05' = Original Loyalty Card Program
        type: string
      giftProgramType:
        description: >-
          This field is for Valutec gift/loyalty card type. The value 0 is for
          gift and 1 for loyalty
        type: string
      invokeManualEntry:
        description: ' Invokes manual card entry.'
        type: boolean
      isCscSupported:
        description: >-
          Invokes prompt for cardholder to enter card security code for manual
          keyed card entry.
        type: string
      laneId:
        description: Specifies which lane to use.
        format: int32
        type: integer
      lodging:
        $ref: '#/definitions/POST_LodgingAuthorization_v1_refund'
        description: >-
          The lodging parameters to be passed in for a lodging transaction. <a
          href='https://triposcert.vantiv.com/api/help/kb/lodging.html'>more&raquo;</a>
      pinlessPosConversionIndicator:
        description: >-
          Flag indicating desire to convert Credit card Refund transaction to a
          PINless Debit Card transaction. <a
          href='https://triposcert.vantiv.com/api/help/kb/PinlessDebitConversion.html'>more&raquo;</a>
        type: string
      preRead:
        description: >-
          Flag indicating desire to process refund as PreRead (i.e. - do ONLY
          Pre-Read operations, then expecting next endpoint call to be
          QuickChip) <a
          href='https://triposcert.vantiv.com/api/help/kb/cloud/QuickChipConfiguration.html'>more&raquo;</a>.
        type: boolean
      preReadId:
        $ref: '#/definitions/POST_Guid_v1_refund'
        description: >-
          The preReadId returned in the pre-read response. This value should be
          a GUID.<a
          href='..\help\kb\QuickChipWithPreReadId.html'>more&raquo;</a>.
      quickChip:
        description: >-
          Flag indicating desire to process refund as QuickChip (i.e. - Pre-Read
          has been previously performed) <a
          href='https://triposcert.vantiv.com/api/help/kb/cloud/QuickChipConfiguration.html'>more&raquo;</a>.
        type: boolean
      referenceNumber:
        description: A user defined reference number.
        type: string
      salesTaxAmount:
        description: >-
          The amount of sales tax for the transaction. This is for Level II,
          submit amount for tax or 0.00 for tax-exempt.
        format: double
        type: number
      shiftId:
        description: An optional shift id for reference.
        type: string
      storeCard:
        $ref: '#/definitions/POST_StoreCard_v1_refund'
        description: Information necessary to process a StoreCard transaction.
      ticketNumber:
        description: An optional ticket number.
        type: string
      transactionAmount:
        description: >-
          The total transaction amount. This is the amount of funds to move on
          the card
        type: string
    required:
      - laneId
      - transactionAmount
  RefundRequestConfiguration:
    description: RefundRequestConfiguration
    properties:
      allowPartialApprovals:
        description: 'If set to false, partial approvals are not allowed'
        type: boolean
      cardReadRetries:
        description: "Number of retries in case of bad card read. The\_default\_value\_is\_1."
        format: int32
        type: integer
      checkForDuplicateTransactions:
        description: >-
          If set to true, enables duplicate checking logic for the transaction
          at the host.
        type: boolean
      isGiftSupported:
        description: Use this parameter to allow Vantiv & Valutec gift cards to be used.
        type: string
      isManualEntryAllowed:
        description: >-
          Use this parameter to allow manual entry of card account numbers on
          the PIN pad.
        type: string
      marketCode:
        description: 'The market code of the transaction. '
        type: string
      promptForSignature:
        description: >-
          Specifies how the signature prompt should be handled for the request.
          If a value is not provided, Always will be used.  See <a
          href='https://triposcert.vantiv.com/api/help/kb/signaturePrompt.html'>Signature Prompt</a>.
        type: string
      provisionalAmount:
        description: >-
          Override provisional amount used for QC transactions, which is $1.00
          by default
        type: string
      userInputTimeout:
        description: Specifies the user input timeout.
        type: string
  RefundResponse:
    description: RefundResponse
    properties:
      _errors:
        description: A list of errors that occurred.
        items:
          $ref: '#/definitions/ApiError'
        type: array
      _hasErrors:
        description: Indicates if there are errors.
        type: boolean
      _links:
        description: A list of resource links
        items:
          $ref: '#/definitions/ApiLink'
        type: array
      _logs:
        description: >-
          A list of log entries detailing what happened during the request.
          Ideally only used during development or troubleshooting as this can be
          quite verbose.
        items:
          type: string
        type: array
      _processor:
        $ref: '#/definitions/Processor'
        description: Response information from the processor.
      _type:
        description: The type of object held in the result.
        type: string
      _warnings:
        description: A list of warnings that occurred.
        items:
          $ref: '#/definitions/ApiWarning'
        type: array
      accountNumber:
        description: The card account number.
        type: string
      accountType:
        description: The account type selected and used in the transaction.
        type: string
      approvalNumber:
        description: >-
          Approval number from the processor. Depending on card type and
          processor an approval number might not be returned.
        type: string
      balanceAmount:
        description: The balance of the gift card.
        format: double
        type: number
      balanceCurrencyCode:
        description: The balance currency code.
        type: string
      binAttributes:
        $ref: '#/definitions/Dictionary_String_Boolean'
        description: >-
          Available binAttributes of card. <a
          href='https://triposcert.vantiv.com/api/help/kb/cardBinAttributes.html'>more&raquo;</a>
      binValue:
        description: The BIN entry that matched the account number.
        type: string
      cardHolderName:
        description: The cardholder name.
        type: string
      cardLogo:
        description: >-
          The card logo. Possible values are: Visa, Mastercard, Discover, Amex,
          Diners Club, JCB, Carte Blanche, Other.
        type: string
      convenienceFeeAmount:
        description: The convenience fee amount.
        format: double
        type: number
      conversionRate:
        description: Conversion rate for the ForeignCurrencyCode.
        type: string
      countryCode:
        description: The country code used in the transaction.
        type: string
      currencyCode:
        description: The currency code used in the transaction.
        type: string
      driverID:
        description: Fleet DriverID Input On The Device
        type: string
      ebtType:
        description: The type of the EBT card
        type: string
      emv:
        $ref: '#/definitions/Emv'
        description: >-
          The fields used on the receipt for an EMV transaction. Null if the
          transaction was not EMV.
      entryMode:
        description: Description of how card was entered.
        type: string
      expirationMonth:
        description: The card's expiration month
        type: string
      expirationYear:
        description: The card's expiration year
        type: string
      fleetAdditionalPromptedData1:
        description: Fleet Additional Prompted Data1 Input On The Device
        type: string
      fleetAdditionalPromptedData2:
        description: Fleet Additional Prompted Data2 Input On The Device
        type: string
      fleetEmployeeNumber:
        description: Fleet Employee Number Input On The Device
        type: string
      fleetJobNumber:
        description: Fleet Job Number Input On The Device
        type: string
      fleetTrailerNumber:
        description: Fleet Trailer Number Input On The Device
        type: string
      fleetUserID:
        description: Fleet UserID Input On The Device
        type: string
      foreignCurrencyCode:
        description: Currency code of the foreign currency.
        type: string
      foreignTransactionAmount:
        description: Transaction amount shown in the foreign currency.
        type: string
      giftPointsBalance:
        description: >-
          This field provides gift points balance for Valutec gift/loyalty
          cards.
        type: string
      giftRewardLevel:
        description: This field provides gift reward level for Valutec gift/loyalty cards.
        type: string
      isApproved:
        description: Set to true if the host approved the transaction.
        type: boolean
      isFleetOdometerPrint:
        description: is Fleet Odometer value Print On the Receipt or not
        type: boolean
      isOffline:
        description: >-
          A boolean value indicating whether triPOS is disconnected from the
          host.
        type: boolean
      language:
        description: The language used in the transaction.
        type: string
      merchantId:
        description: The Merchant used to process the transaction.
        type: string
      networkLabel:
        description: >-
          Label that shows the network where the transaction was routed for
          authorization
        type: string
      odometer:
        description: Fleet Odometer Input On The Device
        type: string
      paymentType:
        description: Description of payment type utilized.
        type: string
      pinVerified:
        description: 'True if the PIN was verified, false if not verified or undetermined.'
        type: boolean
      pinlessPosConversionIndicator:
        description: >-
          Indicates whether the Credit card Refund transaction converted to a
          PINless Debit Card transaction.
        type: string
      preReadId:
        $ref: '#/definitions/Guid'
        description: >-
          Unique ID. If checkForPreReadId field is true, then this ID will be
          required for the Quick Chip portion of the transaction to be
          successful.
      purchaseDeviceSequenceNumber:
        description: Fleet Purchase Device Sequence Number from the card
        type: string
      quickChipMessage:
        description: The message unique to QuickChip pre-read functionality only.
        type: string
      signature:
        $ref: '#/definitions/Signature'
        description: The signature data.
      statusCode:
        description: The status code for the transaction.
        type: string
      terminalId:
        description: The ID of the terminal used during the transaction
        type: string
      tokenId:
        description: The Token ID.
        type: string
      tokenProvider:
        description: The Token Provider.
        type: string
      totalAmount:
        description: The total amount of the transaction.
        format: double
        type: number
      transactionDateTime:
        description: Transaction date/time in ISO8601 format
        type: string
      transactionId:
        description: The transaction ID from the processor
        type: string
      vehicleID:
        description: Fleet Vehicle ID Input On The Device
        type: string
  ReloadGiftRequest:
    description: ReloadGiftRequest
    properties:
      cardHolderPresentCode:
        description: >-
          Defines whether the cardholder is present at the transaction. This
          value is optional, but recommended to be set. If this value is not set
          in the request, it will be automatically set based on the market code.
        type: string
      clerkNumber:
        description: An optional clerk number for reference.
        type: string
      configuration:
        $ref: '#/definitions/POST_RequestConfiguration_v1_gift_reload'
        description: >-
          Any value included in this section will override the corresponding
          value set in the triPOS.config
      giftCardProgram:
        description: >-
          This field is for Valutec gift/loyalty card program. <br>'01' =
          Original Gift Card Program <br>'02' = Promotional Gift Card Program
          <br>'03' = Original Combo Card Program <br>'04' = Auto Rewards LPR
          Card Program <br>'05' = Original Loyalty Card Program
        type: string
      giftProgramType:
        description: >-
          This field is for Valutec gift/loyalty card type. The value 0 is for
          gift and 1 for loyalty
        type: string
      invokeManualEntry:
        description: ' Invokes manual card entry.'
        type: boolean
      isCscSupported:
        description: >-
          Invokes prompt for cardholder to enter card security code for manual
          keyed card entry.
        type: string
      laneId:
        description: Specifies which lane to use.
        format: int32
        type: integer
      referenceNumber:
        description: A user defined reference number.
        type: string
      shiftId:
        description: An optional shift id for reference.
        type: string
      storeCard:
        $ref: '#/definitions/POST_StoreCard_v1_gift_reload'
        description: Information necessary to process a StoreCard transaction.
      ticketNumber:
        description: An optional ticket number.
        type: string
      transactionAmount:
        description: >-
          The total transaction amount. This is the amount of funds to move on
          the card
        format: double
        type: number
    required:
      - laneId
      - transactionAmount
  ReloadGiftResponse:
    description: ReloadGiftResponse
    properties:
      _errors:
        description: A list of errors that occurred.
        items:
          $ref: '#/definitions/ApiError'
        type: array
      _hasErrors:
        description: Indicates if there are errors.
        type: boolean
      _links:
        description: A list of resource links
        items:
          $ref: '#/definitions/ApiLink'
        type: array
      _logs:
        description: >-
          A list of log entries detailing what happened during the request.
          Ideally only used during development or troubleshooting as this can be
          quite verbose.
        items:
          type: string
        type: array
      _processor:
        $ref: '#/definitions/Processor'
        description: Response information from the processor.
      _type:
        description: The type of object held in the result.
        type: string
      _warnings:
        description: A list of warnings that occurred.
        items:
          $ref: '#/definitions/ApiWarning'
        type: array
      accountNumber:
        description: The card account number.
        type: string
      approvalNumber:
        description: >-
          Approval number from the processor. Depending on card type and
          processor an approval number might not be returned.
        type: string
      approvedAmount:
        description: The amount approved for the transaction.
        format: double
        type: number
      balanceAmount:
        description: The balance of the gift card.
        format: double
        type: number
      balanceCurrencyCode:
        description: The balance currency code.
        type: string
      binAttributes:
        $ref: '#/definitions/Dictionary_String_Boolean'
        description: >-
          Available binAttributes of card. <a
          href='https://triposcert.vantiv.com/api/help/kb/cardBinAttributes.html'>more&raquo;</a>
      binValue:
        description: The BIN entry that matched the account number.
        type: string
      cardLogo:
        description: 'The card logo (e.g. Visa, Mastercard, etc).'
        type: string
      entryMode:
        description: 'Description of how card was entered: Keyed, Swiped, Chip.'
        type: string
      giftPointsBalance:
        description: >-
          This field provides gift points balance for Valutec gift/loyalty
          cards.
        type: string
      giftRewardLevel:
        description: This field provides gift reward level for Valutec gift/loyalty cards.
        type: string
      isApproved:
        description: Set to true if the host approved the transaction.
        type: boolean
      isOffline:
        description: >-
          A boolean value indicating whether triPOS is disconnected from the
          host.
        type: boolean
      merchantId:
        description: The Merchant used to process the transaction.
        type: string
      statusCode:
        description: The status code for the transaction.
        type: string
      terminalId:
        description: The ID of the terminal used during the transaction
        type: string
      totalAmount:
        description: The total amount of the transaction.
        format: double
        type: number
      transactionDateTime:
        description: Transaction date/time in ISO8601 format
        type: string
      transactionId:
        description: The transaction ID from the processor
        type: string
  ReportingDataItemDto:
    description: ReportingDataItemDto
    properties:
      HostResponseCode:
        description: Response code for the transaction returned by the host that processed.
        type: string
      acceptorId:
        description: Unique merchant account identifier. Assigned by Element Payment.
        type: string
      accountId:
        description: Unique account ID. Assigned by Element Payment Services.
        type: string
      applicationId:
        description: Unique application identifier. This value is assigned by Element.
        type: string
      approvalNumber:
        description: Issuer assigned approval number.
        type: string
      approvedAmount:
        description: Approved dollar amount.
        format: double
        type: number
      avsResponseCode:
        description: Address verification response code.
        type: string
      cardLogo:
        description: >-
          Brand of the card. Possible values include: Visa, Mastercard,
          Discover.
        type: string
      cardNumberMasked:
        description: Masked card account number.
        type: string
      cardType:
        description: Type of the card.
        type: string
      cvvResponseCode:
        description: Card verification value response code.
        type: string
      expirationMonth:
        description: Expiration month.
        type: string
      expirationYear:
        description: Expiration year.
        type: string
      expressBoolStringTrackDataPresent:
        description: Express Bool String Track Data Present.
        type: string
      expressEnumIntExpressResponseCode:
        description: Express Enum Int Express Response Code.
        format: int32
        type: integer
      expressEnumIntTransactionStatusCode:
        description: Express Enum Int Transaction Status Code.
        format: int32
        type: integer
      expressResponseCode:
        description: The result of the transaction as determined by Express.
        type: string
      expressResponseMessage:
        description: >-
          A brief text description of the result of the transaction as
          determined.
        type: string
      expressTransactionDate:
        description: >-
          The date when Express processed the transaction. The format of this
          property is YYYYMMDD.
        type: string
      expressTransactionTime:
        description: >-
          The time when Express processed the transaction. The format of this
          property is HHMMSS where HH is 00-23.
        type: string
      hostBatchId:
        description: Host batch ID.
        type: string
      hostItemId:
        description: Host item ID.
        type: string
      hostResponseMessage:
        description: Response message for the transaction returned by the host that.
        type: string
      name:
        description: Name.
        type: string
      referenceNumber:
        description: User assigned reference number.
        type: string
      terminalId:
        description: Unique terminal identifier assigned by Element Payment Serivces.
        type: string
      trackDataPresent:
        description: Indicates whether track data was present in the transaction.
        type: boolean
      trackingId:
        description: Tracking ID.
        type: string
      transactionAmount:
        description: Dollar amount of the transaction.
        format: double
        type: number
      transactionId:
        description: Unique transaction identifier.
        type: string
      transactionStatus:
        description: Description of the status/state of the transaction.
        type: string
      transactionStatusCode:
        description: Status/state of the transaction.
        type: string
      transactionType:
        description: Type of transaction.
        type: string
  RequestConfiguration:
    description: RequestConfiguration
    properties:
      allowPartialApprovals:
        description: 'If set to false, partial approvals are not allowed'
        type: boolean
      checkForDuplicateTransactions:
        description: >-
          If set to true, enables duplicate checking logic for the transaction
          at the host.
        type: boolean
      marketCode:
        description: 'The market code of the transaction. '
        type: string
  ReturnRequest:
    description: ReturnRequest
    properties:
      address:
        $ref: '#/definitions/POST_Address_v1_sale_transactionId_return_paymentType'
        description: The cardholder address information for the transaction.
      autoRental:
        $ref: >-
          #/definitions/POST_AutoRentalBasic_v1_sale_transactionId_return_paymentType
        description: >-
          The auto rental parameters to be passed in for an auto rental
          transaction. <a href='https://triposcert.vantiv.com/api/help/kb/autorental.html'>more&raquo;</a>
      cardHolderPresentCode:
        description: >-
          Defines whether the cardholder is present at the transaction. This
          value is optional, but recommended to be set. If this value is not set
          in the request, it will be automatically set based on the market code.
        type: string
      clerkNumber:
        description: An optional clerk number for reference.
        type: string
      commercialCardCustomerCode:
        description: >-
          The commercial card customer code for the transaction. This is for
          Level II.
        type: string
      configuration:
        $ref: >-
          #/definitions/POST_ReturnRequestConfiguration_v1_sale_transactionId_return_paymentType
        description: >-
          Any value included in this section will override the corresponding
          value set in the triPOS.config
      fleet:
        $ref: '#/definitions/POST_Fleet_v1_sale_transactionId_return_paymentType'
        description: >-
          The fleet section that contains all applicable fleet. <a
          href='https://triposcert.vantiv.com/api/help/kb/fleet.html'>more&raquo;</a>
      giftCardProgram:
        description: >-
          This field is for Valutec gift/loyalty card program. <br>'01' =
          Original Gift Card Program <br>'02' = Promotional Gift Card Program
          <br>'03' = Original Combo Card Program <br>'04' = Auto Rewards LPR
          Card Program <br>'05' = Original Loyalty Card Program
        type: string
      giftProgramType:
        description: >-
          This field is for Valutec gift/loyalty card type. The value 0 is for
          gift and 1 for loyalty
        type: string
      laneId:
        description: Specifies which lane to use.
        format: int32
        type: integer
      lodging:
        $ref: >-
          #/definitions/POST_LodgingAuthorization_v1_sale_transactionId_return_paymentType
        description: >-
          The lodging parameters to be passed in for a lodging transaction. <a
          href='https://triposcert.vantiv.com/api/help/kb/lodging.html'>more&raquo;</a>
      referenceNumber:
        description: A user defined reference number.
        type: string
      salesTaxAmount:
        description: >-
          The amount of sales tax for the transaction. This is for Level II,
          submit amount for tax or 0.00 for tax-exempt.
        format: double
        type: number
      shiftId:
        description: An optional shift id for reference.
        type: string
      storeCard:
        $ref: '#/definitions/POST_StoreCard_v1_sale_transactionId_return_paymentType'
        description: Information necessary to process a StoreCard transaction.
      ticketNumber:
        description: An optional ticket number.
        type: string
      transactionAmount:
        description: >-
          The total transaction amount. This is the amount of funds to move on
          the card
        format: double
        type: number
    required:
      - laneId
      - transactionAmount
  ReturnRequestConfiguration:
    description: ReturnRequestConfiguration
    properties:
      allowPartialApprovals:
        description: 'If set to false, partial approvals are not allowed'
        type: boolean
      checkForDuplicateTransactions:
        description: >-
          If set to true, enables duplicate checking logic for the transaction
          at the host.
        type: boolean
      marketCode:
        description: 'The market code of the transaction. '
        type: string
      promptForSignature:
        description: >-
          Specifies how the signature prompt should be handled for the request.
          If a value is not provided, Always will be used. See <a
          href='https://triposcert.vantiv.com/api/help/kb/signaturePrompt.html'>Signature Prompt</a>.
        type: string
  ReturnResponse:
    description: ReturnResponse
    properties:
      _errors:
        description: A list of errors that occurred.
        items:
          $ref: '#/definitions/ApiError'
        type: array
      _hasErrors:
        description: Indicates if there are errors.
        type: boolean
      _links:
        description: A list of resource links
        items:
          $ref: '#/definitions/ApiLink'
        type: array
      _logs:
        description: >-
          A list of log entries detailing what happened during the request.
          Ideally only used during development or troubleshooting as this can be
          quite verbose.
        items:
          type: string
        type: array
      _processor:
        $ref: '#/definitions/Processor'
        description: Response information from the processor.
      _type:
        description: The type of object held in the result.
        type: string
      _warnings:
        description: A list of warnings that occurred.
        items:
          $ref: '#/definitions/ApiWarning'
        type: array
      accountNumber:
        description: The card account number.
        type: string
      accountType:
        description: The account type selected and used in the transaction.
        type: string
      approvalNumber:
        description: >-
          Approval number from the processor. Depending on card type and
          processor an approval number might not be returned.
        type: string
      balanceAmount:
        description: The balance of the gift card.
        format: double
        type: number
      balanceCurrencyCode:
        description: The balance currency code.
        type: string
      binAttributes:
        $ref: '#/definitions/Dictionary_String_Boolean'
        description: >-
          Available binAttributes of card. <a
          href='https://triposcert.vantiv.com/api/help/kb/cardBinAttributes.html'>more&raquo;</a>
      binValue:
        description: The BIN entry that matched the account number.
        type: string
      cardHolderName:
        description: The cardholder name.
        type: string
      cardLogo:
        description: >-
          The card logo. Possible values are: Visa, Mastercard, Discover, Amex,
          Diners Club, JCB, Carte Blanche, Other.
        type: string
      conversionRate:
        description: Conversion rate for the ForeignCurrencyCode.
        type: string
      countryCode:
        description: The country code used in the transaction.
        type: string
      currencyCode:
        description: The currency code used in the transaction.
        type: string
      driverID:
        description: Fleet DriverID Input On The Device
        type: string
      ebtType:
        description: The type of the EBT card
        type: string
      expirationMonth:
        description: The card's expiration month
        type: string
      expirationYear:
        description: The card's expiration year
        type: string
      fleetAdditionalPromptedData1:
        description: Fleet Additional Prompted Data1 Input On The Device
        type: string
      fleetAdditionalPromptedData2:
        description: Fleet Additional Prompted Data2 Input On The Device
        type: string
      fleetEmployeeNumber:
        description: Fleet Employee Number Input On The Device
        type: string
      fleetJobNumber:
        description: Fleet Job Number Input On The Device
        type: string
      fleetTrailerNumber:
        description: Fleet Trailer Number Input On The Device
        type: string
      fleetUserID:
        description: Fleet UserID Input On The Device
        type: string
      foreignCurrencyCode:
        description: Currency code of the foreign currency.
        type: string
      foreignTransactionAmount:
        description: Transaction amount shown in the foreign currency.
        type: string
      giftPointsBalance:
        description: >-
          This field provides gift points balance for Valutec gift/loyalty
          cards.
        type: string
      giftRewardLevel:
        description: This field provides gift reward level for Valutec gift/loyalty cards.
        type: string
      isApproved:
        description: Set to true if the host approved the transaction.
        type: boolean
      isFleetOdometerPrint:
        description: is Fleet Odometer value Print On the Receipt or not
        type: boolean
      isOffline:
        description: >-
          A boolean value indicating whether triPOS is disconnected from the
          host.
        type: boolean
      language:
        description: The language used in the transaction.
        type: string
      merchantId:
        description: The Merchant used to process the transaction.
        type: string
      networkLabel:
        description: >-
          Label that shows the network where the transaction was routed for
          authorization
        type: string
      odometer:
        description: Fleet Odometer Input On The Device
        type: string
      paymentType:
        description: Description of payment type utilized.
        type: string
      pinVerified:
        description: 'True if the PIN was verified, false if not verified or undetermined.'
        type: boolean
      preReadId:
        $ref: '#/definitions/Guid'
        description: >-
          Unique ID. If checkForPreReadId field is true, then this ID will be
          required for the Quick Chip portion of the transaction to be
          successful.
      purchaseDeviceSequenceNumber:
        description: Fleet Purchase Device Sequence Number from the card
        type: string
      signature:
        $ref: '#/definitions/Signature'
        description: The signature data.
      statusCode:
        description: The status code for the transaction.
        type: string
      terminalId:
        description: The ID of the terminal used during the transaction
        type: string
      totalAmount:
        description: The total amount of the transaction.
        format: double
        type: number
      transactionDateTime:
        description: Transaction date/time in ISO8601 format
        type: string
      transactionId:
        description: The transaction ID from the processor
        type: string
      vehicleID:
        description: Fleet Vehicle ID Input On The Device
        type: string
  ReversalRequest:
    description: ReversalRequest
    properties:
      cardHolderPresentCode:
        description: >-
          Defines whether the cardholder is present at the transaction. This
          value is optional, but recommended to be set. If this value is not set
          in the request, it will be automatically set based on the market code.
        type: string
      clerkNumber:
        description: An optional clerk number for reference.
        type: string
      configuration:
        $ref: >-
          #/definitions/POST_TransactionIdRequestConfiguration_v1_reversal_transactionId_paymentType
        description: >-
          Any value included in this section will override the corresponding
          value set in the triPOS.config
      convenienceFeeAmount:
        description: The convenience fee amount.
        format: double
        type: number
      ebtType:
        description: >-
          EBT card type of the original transaction. This is required when
          payment type is EBT.
        type: string
      getToken:
        description: To retrieve Token in the transaction.
        type: string
      giftCardProgram:
        description: >-
          This field is for Valutec gift/loyalty card program. <br>'01' =
          Original Gift Card Program <br>'02' = Promotional Gift Card Program
          <br>'03' = Original Combo Card Program <br>'04' = Auto Rewards LPR
          Card Program <br>'05' = Original Loyalty Card Program
        type: string
      giftProgramType:
        description: >-
          This field is for Valutec gift/loyalty card type. The value 0 is for
          gift and 1 for loyalty
        type: string
      laneId:
        description: Specifies which lane to use.
        format: int32
        type: integer
      networkTransactionID:
        description: >-
          The card brand specific transaction ID that should be stored by the
          integrator.
        type: string
      recurringPaymentType:
        description: Intent of why the credentials are being stored.
        type: string
      referenceNumber:
        description: A user defined reference number.
        type: string
      shiftId:
        description: An optional shift id for reference.
        type: string
      storeCard:
        $ref: '#/definitions/POST_StoreCard_v1_reversal_transactionId_paymentType'
        description: Information necessary to process a StoreCard transaction.
      submissionType:
        description: Initial vs Subsequent Transaction.
        type: string
      ticketNumber:
        description: An optional ticket number.
        type: string
      transactionAmount:
        description: 'The original transaction amount. '
        format: double
        type: number
      type:
        description: The type of reversal.
        type: string
    required:
      - laneId
      - transactionAmount
  ReversalResponse:
    description: ReversalResponse
    properties:
      _errors:
        description: A list of errors that occurred.
        items:
          $ref: '#/definitions/ApiError'
        type: array
      _hasErrors:
        description: Indicates if there are errors.
        type: boolean
      _links:
        description: A list of resource links
        items:
          $ref: '#/definitions/ApiLink'
        type: array
      _logs:
        description: >-
          A list of log entries detailing what happened during the request.
          Ideally only used during development or troubleshooting as this can be
          quite verbose.
        items:
          type: string
        type: array
      _processor:
        $ref: '#/definitions/Processor'
        description: Response information from the processor.
      _type:
        description: The type of object held in the result.
        type: string
      _warnings:
        description: A list of warnings that occurred.
        items:
          $ref: '#/definitions/ApiWarning'
        type: array
      accountNumber:
        description: The card account number.
        type: string
      approvalNumber:
        description: >-
          Approval number from the processor. Depending on card type and
          processor an approval number might not be returned.
        type: string
      balanceAmount:
        description: The balance of the gift card.
        format: double
        type: number
      cardLogo:
        description: >-
          The card logo. Possible values are: Visa, Mastercard, Discover, Amex,
          Diners Club, JCB, Carte Blanche, Other
        type: string
      convenienceFeeAmount:
        description: The convenience fee amount.
        format: double
        type: number
      giftPointsBalance:
        description: >-
          This field provides gift points balance for Valutec gift/loyalty
          cards.
        type: string
      giftRewardLevel:
        description: This field provides gift reward level for Valutec gift/loyalty cards.
        type: string
      isApproved:
        description: Set to true if the host approved the transaction.
        type: boolean
      isOffline:
        description: >-
          A boolean value indicating whether triPOS is disconnected from the
          host.
        type: boolean
      merchantId:
        description: The Merchant used to process the transaction.
        type: string
      paymentType:
        description: 'Original card payment type: Credit, Debit, Gift, EBT'
        type: string
      statusCode:
        description: The status code for the transaction.
        type: string
      terminalId:
        description: The ID of the terminal used during the transaction
        type: string
      tokenId:
        description: The Token ID.
        type: string
      tokenProvider:
        description: The Token Provider.
        type: string
      totalAmount:
        description: The total amount of the transaction.
        format: double
        type: number
      transactionDateTime:
        description: Transaction date/time in ISO8601 format
        type: string
      transactionId:
        description: The transaction ID from the processor
        type: string
  SaleRequest:
    description: SaleRequest
    properties:
      address:
        $ref: '#/definitions/POST_Address_v1_sale'
        description: The cardholder address information for the transaction.
      autoRental:
        $ref: '#/definitions/POST_AutoRental_v1_sale'
        description: >-
          The auto rental parameters to be passed in for an auto rental
          transaction. <a href='https://triposcert.vantiv.com/api/help/kb/autorental.html'>more&raquo;</a>
      cardHolderPresentCode:
        description: >-
          Defines whether the cardholder is present at the transaction. This
          value is optional, but recommended to be set. If this value is not set
          in the request, it will be automatically set based on the market code.
        type: string
      checkForPreReadId:
        description: >-
          Flag to support 'PreReadId feature in quick chip' transaction request.
          This will take precedence over triPOS.config flag.
        type: boolean
      clerkNumber:
        description: An optional clerk number for reference.
        type: string
      commercialCardCustomerCode:
        description: >-
          The commercial card customer code for the transaction. This is for
          Level II.
        type: string
      configuration:
        $ref: '#/definitions/POST_SaleRequestConfiguration_v1_sale'
        description: >-
          Any value included in this section will override the corresponding
          value set in the triPOS.config
      convenienceFeeAmount:
        description: >-
          The convenience fee amount of the transaction. This amount is added to
          the TotalAmount before the cardholder is charged. <a
          href='https://triposcert.vantiv.com/api/help/kb/convenienceFeeAmount.html'>more&raquo;</a>
        format: double
        type: number
      creditSurchargeAmount:
        description: >-
          The credit surcharge amount of the transaction. This amount is added
          to the TotalAmount before the cardholder is charged. <a
          href='https://triposcert.vantiv.com/api/help/kb/cloud/Surcharging.html'>more&raquo;</a>
        format: double
        type: number
      currencyCode:
        description: The currency code used in the transaction.
        type: string
      displayTransactionAmount:
        description: Display the transaction amount during card read.
        type: boolean
      ebtType:
        description: EbtType may be FoodStamp or CashBenefit
        type: string
      estimatedAmountIndicator:
        description: >-
          The EstimatedAmountIndicator can be used by merchants/integrators to
          define the TransactionAmount submitted to Express either as an
          Estimated Amount (i.e. amount to charge cardholder may change) or a
          Final Amount (i.e. amount to charge cardholder will not change).  It
          will be a 1-character request field supporting the following request
          settings:
        type: string
      fleet:
        $ref: '#/definitions/POST_Fleet_v1_sale'
        description: >-
          The fleet section that contains all applicable fleet. <a
          href='https://triposcert.vantiv.com/api/help/kb/fleet.html'>more&raquo;</a>
      foodStampAmount:
        description: >-
          If POS app sends FoodStampAmount, then replace OriginalAmount with
          FoodStampAmount for EBT FoodStamp transactions
        format: double
        type: number
      getToken:
        description: >-
          To retrieve Token in the transaction. <a
          href='https://triposcert.vantiv.com/api/help/kb/GetToken.html'>more&raquo;</a>
        type: string
      giftCardProgram:
        description: >-
          This field is for Valutec gift/loyalty card program. <br>'01' =
          Original Gift Card Program <br>'02' = Promotional Gift Card Program
          <br>'03' = Original Combo Card Program <br>'04' = Auto Rewards LPR
          Card Program <br>'05' = Original Loyalty Card Program
        type: string
      giftProgramType:
        description: >-
          This field is for Valutec gift/loyalty card type. The value 0 is for
          gift and 1 for loyalty
        type: string
      healthcare:
        $ref: '#/definitions/POST_Healthcare_v1_sale'
        description: >-
          The healthcare section that contains all applicable
          healthcare-qualified amounts. <a
          href='https://triposcert.vantiv.com/api/help/kb/healthcare.html'>more&raquo;</a>
      invokeManualEntry:
        description: Invoke manual entry card read.
        type: boolean
      isCscSupported:
        description: >-
          Invokes prompt for cardholder to enter card security code for manual
          keyed card entry.
        type: string
      laneId:
        description: Specifies which lane to use.
        format: int32
        type: integer
      lodging:
        $ref: '#/definitions/POST_LodgingTransactionCompletion_v1_sale'
        description: >-
          The lodging parameters to be passed in for a lodging transaction. <a
          href='https://triposcert.vantiv.com/api/help/kb/lodging.html'>more&raquo;</a>
      networkTransactionID:
        description: >-
          The card brand specific transaction ID that should be stored by the
          integrator.
        type: string
      nonFinancialExpected:
        description: >-
          Non Financial Card read Expected. Only supported on unattended
          devices.
        type: boolean
      pinlessPosConversionIndicator:
        description: >-
          Flag indicating desire to convert Credit card Sale transaction to a
          PINless Debit Card transaction. <a
          href='https://triposcert.vantiv.com/api/help/kb/PinlessDebitConversion.html'>more&raquo;</a>
        type: string
      preRead:
        description: >-
          Flag indicating desire to process sale as PreRead (i.e. - do ONLY
          Pre-Read operations, then expecting next endpoint call to be
          QuickChip) <a
          href='https://triposcert.vantiv.com/api/help/kb/cloud/QuickChipConfiguration.html'>more&raquo;</a>.
        type: boolean
      preReadId:
        $ref: '#/definitions/POST_Guid_v1_sale'
        description: >-
          The preReadId returned in the pre-read response. This value should be
          a GUID.<a
          href='..\help\kb\QuickChipWithPreReadId.html'>more&raquo;</a>.
      quickChip:
        description: >-
          Flag indicating desire to process sale as QuickChip (i.e. - Pre-Read
          has been previously performed) <a
          href='https://triposcert.vantiv.com/api/help/kb/cloud/QuickChipConfiguration.html'>more&raquo;</a>.
        type: boolean
      recurringPaymentType:
        description: Intent of why the credentials are being stored.
        type: string
      referenceNumber:
        description: A user defined reference number.
        type: string
      requestedCashbackAmount:
        description: >-
          The requested cashback amount of the transaction. If the card used is
          cashback capable, this amount will be added to the total amount of the
          transaction. If the card is not cashback capable, the transaction will
          decline. More information on <a
          href='https://triposcert.vantiv.com/api/help/kb/requestedCashbackAmount.html'>RequestedCashbackAmount</a>
          here.
        format: double
        type: number
      salesTaxAmount:
        description: >-
          The amount of sales tax for the transaction. This is for Level II,
          submit amount for tax or 0.00 for tax-exempt.
        format: double
        type: number
      shiftId:
        description: An optional shift id for reference.
        type: string
      storeCard:
        $ref: '#/definitions/POST_StoreCard_v1_sale'
        description: Information necessary to process a StoreCard transaction.
      submissionType:
        description: Initial vs Subsequent Transaction.
        type: string
      ticketNumber:
        description: An optional ticket number.
        type: string
      tipAmount:
        description: >-
          The tip amount of the transaction. This amount is added to the
          TotalAmount before the cardholder is charged.
        format: double
        type: number
      transactionAmount:
        description: >-
          The total transaction amount. This is the amount of funds to move on
          the card
        type: string
    required:
      - laneId
      - transactionAmount
  SaleRequestConfiguration:
    description: SaleRequestConfiguration
    properties:
      allowDebit:
        description: >-
          Use this parameter to allow debit <a
          href='https://triposcert.vantiv.com/api/help/kb/allowDebit.html'>more&raquo;</a>.
        type: boolean
      allowPartialApprovals:
        description: 'If set to false, partial approvals are not allowed'
        type: boolean
      allowedPaymentTypes:
        description: >-
          Pass in either or both values. If a single value is passed then no AID
          option will be presented for cardholder to select and automatic AID
          selection will happen, assuming only one credit/debit AID is available
          on a card. In case, multiple credit AIDs or multiple debit AIDs are
          available on a card, then choice will be given to choose among the
          filtered list of credit/debit AIDs.<a
          href='https://triposcert.vantiv.com/api/help/kb/allowPaymentTypes.html'>more&raquo;</a>
        items:
          type: string
        type: array
      cardReadRetries:
        description: "Number of retries in case of bad card read. The\_default\_value\_is\_1."
        format: int32
        type: integer
      cashbackOptions:
        $ref: '#/definitions/POST_CashbackOptions_v1_sale'
        description: >-
          Use this section to specify cashback options for each request <a
          href='https://triposcert.vantiv.com/api/help/kb/cashbackOptions.html'>more&raquo;</a>.
      checkForDuplicateTransactions:
        description: >-
          If set to true, enables duplicate checking logic for the transaction
          at the host.
        type: boolean
      confirmOriginalAmount:
        description: >-
          Use this parameter to confirm the sale original amount <a
          href='https://triposcert.vantiv.com/api/help/kb/confirmOriginalAmount.html'>more&raquo;</a>.
        type: string
      isGiftSupported:
        description: Use this parameter to allow Vantiv & Valutec gift cards to be used.
        type: string
      isManualEntryAllowed:
        description: >-
          Use this parameter to allow manual entry of card account numbers on
          the PIN pad.
        type: string
      marketCode:
        description: 'The market code of the transaction. '
        type: string
      processUSMaestroDebitOffLinePinCvmAsDebit:
        description: >-
          Use this parameter to allow Maestro Debit Aids to be processed as
          Debit if the CVM is Offline PIN
        type: string
      promptForSignature:
        description: >-
          Specifies how the signature prompt should be handled for the request.
          If a value is not provided, UseThreshold will be used. See <a
          href='https://triposcert.vantiv.com/api/help/kb/signaturePrompt.html'>Signature Prompt</a>.
        type: string
      provisionalAmount:
        description: >-
          Override provisional amount used for QC transactions, which is $1.00
          by default
        type: string
      thresholdAmount:
        description: >-
          Specifies the threshold value to use. If included, will override the
          value in the triPOS.config when promptForSignature is UseThreshold.
          See <a href='https://triposcert.vantiv.com/api/help/kb/signaturePrompt.html'>Signature Prompt</a>.
        format: double
        type: number
      tipOptions:
        $ref: '#/definitions/POST_TipOptions_v1_sale'
        description: >-
          If these tip options are sent in, they will override the tip options
          that are currently set in the triPOS.config. To disable tip, send this
          section up with empty values. To use the values from the
          triPOS.config, do not include this section in your request <a
          href='https://triposcert.vantiv.com/api/help/kb/tipOptions.html'>more&raquo;</a>.
      userInputTimeout:
        description: Specifies the user input timeout.
        type: string
  SaleResponse:
    description: SaleResponse
    properties:
      _errors:
        description: A list of errors that occurred.
        items:
          $ref: '#/definitions/ApiError'
        type: array
      _hasErrors:
        description: Indicates if there are errors.
        type: boolean
      _links:
        description: A list of resource links
        items:
          $ref: '#/definitions/ApiLink'
        type: array
      _logs:
        description: >-
          A list of log entries detailing what happened during the request.
          Ideally only used during development or troubleshooting as this can be
          quite verbose.
        items:
          type: string
        type: array
      _processor:
        $ref: '#/definitions/Processor'
        description: Response information from the processor.
      _type:
        description: The type of object held in the result.
        type: string
      _warnings:
        description: A list of warnings that occurred.
        items:
          $ref: '#/definitions/ApiWarning'
        type: array
      accountNumber:
        description: The card account number.
        type: string
      accountType:
        description: The account type selected and used in the transaction.
        type: string
      approvalNumber:
        description: >-
          Approval number from the processor. Depending on card type and
          processor an approval number might not be returned.
        type: string
      approvedAmount:
        description: >-
          The amount approved by the processor. This is the actual amount that
          will be charged or credited.
        format: double
        type: number
      balanceAmount:
        description: The balance of the gift card.
        format: double
        type: number
      balanceCurrencyCode:
        description: The balance currency code.
        type: string
      binAttributes:
        $ref: '#/definitions/Dictionary_String_Boolean'
        description: >-
          Available binAttributes of card. <a
          href='https://triposcert.vantiv.com/api/help/kb/cardBinAttributes.html'>more&raquo;</a>
      binValue:
        description: The BIN entry that matched the account number.
        type: string
      cardHolderName:
        description: The cardholder name.
        type: string
      cardLogo:
        description: >-
          The card logo. Possible values are: Visa, Mastercard, Discover, Amex,
          Diners Club, JCB, Carte Blanche, Other.
        type: string
      cashbackAmount:
        description: The cashback amount the cardholder wants.
        format: double
        type: number
      convenienceFeeAmount:
        description: The convenience fee added to the transaction
        format: double
        type: number
      conversionRate:
        description: Conversion rate for the ForeignCurrencyCode.
        type: string
      countryCode:
        description: The country code used in the transaction.
        type: string
      creditSurchargeAmount:
        description: The surcharge amount that was added to the transaction.
        format: double
        type: number
      currencyCode:
        description: The currency code used in the transaction.
        type: string
      driverID:
        description: Fleet DriverID Input On The Device
        type: string
      ebtType:
        description: The type of the EBT card
        type: string
      emv:
        $ref: '#/definitions/Emv'
        description: >-
          The fields used on the receipt for an EMV transaction. Null if the
          transaction was not EMV.
      entryMode:
        description: Description of how card was entered.
        type: string
      expirationMonth:
        description: The card's expiration month
        type: string
      expirationYear:
        description: The card's expiration year
        type: string
      fleetAdditionalPromptedData1:
        description: Fleet Additional Prompted Data1 Input On The Device
        type: string
      fleetAdditionalPromptedData2:
        description: Fleet Additional Prompted Data2 Input On The Device
        type: string
      fleetEmployeeNumber:
        description: Fleet Employee Number Input On The Device
        type: string
      fleetJobNumber:
        description: Fleet Job Number Input On The Device
        type: string
      fleetTrailerNumber:
        description: Fleet Trailer Number Input On The Device
        type: string
      fleetUserID:
        description: Fleet UserID Input On The Device
        type: string
      foreignCurrencyCode:
        description: Currency code of the foreign currency.
        type: string
      foreignTransactionAmount:
        description: Transaction amount shown in the foreign currency.
        type: string
      fsaCard:
        description: >-
          Indicates whether the card used was a FSA card.<br />Note: Maybe = No
          BIN entry to determine if FSA.
        type: string
      giftPointsBalance:
        description: >-
          This field provides gift points balance for Valutec gift/loyalty
          cards.
        type: string
      giftRewardLevel:
        description: This field provides gift reward level for Valutec gift/loyalty cards.
        type: string
      isApproved:
        description: Set to true if the host approved the transaction.
        type: boolean
      isCardInserted:
        description: >-
          Indicates whether the EMV card was still inserted into the payment
          device when the transaction completed.
        type: boolean
      isFleetOdometerPrint:
        description: is Fleet Odometer value Print On the Receipt or not
        type: boolean
      isOffline:
        description: >-
          A boolean value indicating whether triPOS is disconnected from the
          host.
        type: boolean
      language:
        description: The language used in the transaction.
        type: string
      merchantId:
        description: The Merchant used to process the transaction.
        type: string
      networkLabel:
        description: >-
          Label that shows the network where the transaction was routed for
          authorization
        type: string
      networkTransactionId:
        description: >-
          The card brand specific transaction ID that should be stored by the
          integrator.
        type: string
      nonFinancialData:
        $ref: '#/definitions/NonFinancialCard'
        description: Non Financial data.
      odometer:
        description: Fleet Odometer Input On The Device
        type: string
      paymentType:
        description: Description of payment type utilized.
        type: string
      pinVerified:
        description: 'True if the PIN was verified, false if not verified or undetermined.'
        type: boolean
      pinlessPosConversionIndicator:
        description: >-
          Indicates whether the Credit card Sale transaction converted to a
          PINless Debit Card transaction.
        type: string
      preReadId:
        $ref: '#/definitions/Guid'
        description: >-
          Unique ID. If checkForPreReadId field is true, then this ID will be
          required for the Quick Chip portion of the transaction to be
          successful.
      purchaseDeviceSequenceNumber:
        description: Fleet Purchase Device Sequence Number from the card
        type: string
      quickChipMessage:
        description: The message unique to QuickChip pre-read functionality only.
        type: string
      signature:
        $ref: '#/definitions/Signature'
        description: The signature data.
      statusCode:
        description: The status code for the transaction.
        type: string
      subTotalAmount:
        description: The original amount sent for the transaction.
        format: double
        type: number
      terminalId:
        description: The ID of the terminal used during the transaction
        type: string
      tipAmount:
        description: The tip amount added to the transaction.
        format: double
        type: number
      tokenId:
        description: The Token ID.
        type: string
      tokenProvider:
        description: The Token Provider.
        type: string
      totalAmount:
        description: The total amount of the transaction.
        format: double
        type: number
      transactionDateTime:
        description: Transaction date/time in ISO8601 format
        type: string
      transactionId:
        description: The transaction ID from the processor
        type: string
      transactionStored:
        description: >-
          Indicates the transaction was not able to be processed online and was
          stored instead. This is currently only applicable for Mobile device.
        type: boolean
      vehicleID:
        description: Fleet Vehicle ID Input On The Device
        type: string
  ScrollingDisplayRequest:
    description: ScrollingDisplayRequest
    properties:
      laneId:
        description: The lane ID.
        format: int32
        type: integer
      lineItem:
        description: >-
          The new text line to be added in the scrolling area of the PIN pad
          screen. It typically includes a description and the price of an
          individual item (i.e. Cookies... $3.99).
        type: string
      subtotal:
        description: The new subtotal of all the scanned items including the new line item.
        type: string
      tax:
        description: The tax value of the new subtotal.
        type: string
      total:
        description: The value of the new subtotal and tax.
        type: string
    required:
      - laneId
      - lineItem
      - subtotal
      - tax
      - total
  SelectionDiscoveryRequest:
    description: SelectionDiscoveryRequest
    properties:
      laneId:
        description: Specifies which lane to use.
        format: int32
        type: integer
    required:
      - laneId
  SelectionDiscoveryResponse:
    description: SelectionDiscoveryResponse
    properties:
      _errors:
        description: A list of errors that occurred.
        items:
          $ref: '#/definitions/ApiError'
        type: array
      _hasErrors:
        description: Indicates if there are errors.
        type: boolean
      _links:
        description: A list of resource links
        items:
          $ref: '#/definitions/ApiLink'
        type: array
      _logs:
        description: >-
          A list of log entries detailing what happened during the request.
          Ideally only used during development or troubleshooting as this can be
          quite verbose.
        items:
          type: string
        type: array
      _type:
        description: The type of object held in the result.
        type: string
      _warnings:
        description: A list of warnings that occurred.
        items:
          $ref: '#/definitions/ApiWarning'
        type: array
  SelectionRequest:
    description: SelectionRequest
  SelectionResponse:
    description: SelectionResponse
    properties:
      _errors:
        description: A list of errors that occurred.
        items:
          $ref: '#/definitions/ApiError'
        type: array
      _hasErrors:
        description: Indicates if there are errors.
        type: boolean
      _links:
        description: A list of resource links
        items:
          $ref: '#/definitions/ApiLink'
        type: array
      _logs:
        description: >-
          A list of log entries detailing what happened during the request.
          Ideally only used during development or troubleshooting as this can be
          quite verbose.
        items:
          type: string
        type: array
      _type:
        description: The type of object held in the result.
        type: string
      _warnings:
        description: A list of warnings that occurred.
        items:
          $ref: '#/definitions/ApiWarning'
        type: array
      selectionIndex:
        description: >-
          For the YesNoTextArea form, selectionIndex will be 0 when the
          cardholder selects No and 1 when the cardholder selects Yes. For the
          MultiOption form, selectionIndex is the zero-based index of the option
          that the cardholder selected. The first option specified will be
          considered option 0.
        format: int32
        type: integer
  Signature:
    description: Signature
    properties:
      data:
        description: The byte array of the signature in the format specified by Format.
        items:
          format: byte
          type: string
        type: array
      format:
        description: The format of the signature.
        type: string
      statusCode:
        description: Indicates why a signature is or is not present.
        type: string
  SignatureRequest:
    description: SignatureRequest
    properties:
      laneId:
        description: Specifies which lane to use.
        format: int32
        type: integer
    required:
      - laneId
  SignatureResponse:
    description: SignatureResponse
    properties:
      _errors:
        description: A list of errors that occurred.
        items:
          $ref: '#/definitions/ApiError'
        type: array
      _hasErrors:
        description: Indicates if there are errors.
        type: boolean
      _links:
        description: A list of resource links
        items:
          $ref: '#/definitions/ApiLink'
        type: array
      _logs:
        description: >-
          A list of log entries detailing what happened during the request.
          Ideally only used during development or troubleshooting as this can be
          quite verbose.
        items:
          type: string
        type: array
      _type:
        description: The type of object held in the result.
        type: string
      _warnings:
        description: A list of warnings that occurred.
        items:
          $ref: '#/definitions/ApiWarning'
        type: array
  StatusRequest:
    description: StatusRequest
    properties:
      acceptorId:
        description: >-
          The Express acceptorId. If all three Express credentials are specified
          in the request headers, triPOS will use these credentials instead of
          the credentials in the triPOS.config for that request only.
        type: string
      accountId:
        description: >-
          The Express accountId. If all three Express credentials are specified
          in the request headers, triPOS will use these credentials instead of
          the credentials in the triPOS.config for that request only.
        type: string
      accountToken:
        description: >-
          The Express accountToken. If all three Express credentials are
          specified in the request headers, triPOS will use these credentials
          instead of the credentials in the triPOS.config for that request only.
        type: string
      applicationId:
        description: The ID of the business application.
        type: string
      applicationName:
        description: The name of the business application.
        type: string
      applicationVersion:
        description: The version of the business application.
        type: string
      authorizationSignature:
        description: The authorization header.
        type: string
      ctafObject:
        type: boolean
      laneLock:
        $ref: '#/definitions/GET_ILaneLock_v1_status'
      request:
        type: string
      requestId:
        description: >-
          A unique ID for this request. This value should be a UUID or GUID. <a
          href='https://triposcert.vantiv.com/api/help/kb/requestid.html'>more&raquo;</a>
        type: string
      requestIdAsGuid:
        $ref: '#/definitions/GET_Guid_v1_status'
      returnLogs:
        description: Set to true to have logs populated in the response.
        type: boolean
    required:
      - acceptorId
      - accountId
      - accountToken
      - applicationId
      - applicationName
      - applicationVersion
      - authorizationSignature
      - ctafObject
      - laneLock
      - request
      - requestId
      - requestIdAsGuid
  StatusResponse:
    description: StatusResponse
    properties:
      _errors:
        description: A list of errors that occurred.
        items:
          $ref: '#/definitions/ApiError'
        type: array
      _hasErrors:
        description: Indicates if there are errors.
        type: boolean
      _links:
        description: A list of resource links
        items:
          $ref: '#/definitions/ApiLink'
        type: array
      _logs:
        description: >-
          A list of log entries detailing what happened during the request.
          Ideally only used during development or troubleshooting as this can be
          quite verbose.
        items:
          type: string
        type: array
      _type:
        description: The type of object held in the result.
        type: string
      _warnings:
        description: A list of warnings that occurred.
        items:
          $ref: '#/definitions/ApiWarning'
        type: array
  StoreCard:
    description: StoreCard
    properties:
      Id:
        description: The ID of a StoreCard.
        type: string
      Password:
        description: The password of StoreCard.
        type: string
  Tag:
    description: Tag
    properties:
      key:
        type: string
      value:
        type: string
  TipOptions:
    description: TipOptions
    properties:
      otherOption:
        description: Other option to show to select tip.
        type: string
      tipSelections:
        description: CSV tip amount selections.
        type: string
      type:
        description: >-
          Type of tip entry: Amount selection, Percentage selection, or Prompt
          for custom value entry. Note: The Prompt value overrides the
          otherOption and tipSelections, skipping directly to Tip Amount entry
          screen.
        type: string
  TokenAuthorizationRequest:
    description: TokenAuthorizationRequest
    properties:
      address:
        $ref: '#/definitions/POST_Address_v1_authorization_token'
        description: The cardholder address information for the transaction.
      autoRental:
        $ref: '#/definitions/POST_AutoRentalBasic_v1_authorization_token'
        description: >-
          The auto rental parameters to be passed in for an auto rental
          transaction. <a href='https://triposcert.vantiv.com/api/help/kb/autorental.html'>more&raquo;</a>
      cardLogo:
        description: The card logo of the card that the token represents.
        type: string
      clerkNumber:
        description: An optional clerk number for reference.
        type: string
      configuration:
        $ref: '#/definitions/POST_RequestConfiguration_v1_authorization_token'
        description: >-
          Any value included in this section will override the corresponding
          value set in the triPOS.config
      convenienceFeeAmount:
        description: >-
          The convenience fee amount of the transaction. This amount is added to
          the TotalAmount before the cardholder is charged
        format: double
        type: number
      creditSurchargeAmount:
        description: >-
          The credit surcharge amount of the transaction. This amount is added
          to the TotalAmount before the cardholder is charged
        format: double
        type: number
      estimatedAmountIndicator:
        description: >-
          The EstimatedAmountIndicator can be used by merchants/integrators to
          define the TransactionAmount submitted to Express either as an
          Estimated Amount (i.e. amount to charge cardholder may change) or a
          Final Amount (i.e. amount to charge cardholder will not change).  It
          will be a 1-character request field supporting the following request
          settings:
        type: string
      expirationMonth:
        description: >-
          The expiration month of the card the token represents. Although this
          is not required, it is recommended for fraud protection.
        type: string
      expirationYear:
        description: >-
          The expiration year of the card the token represents. Although this is
          not required, it is recommended for fraud protection.
        type: string
      healthcare:
        $ref: '#/definitions/POST_Healthcare_v1_authorization_token'
        description: >-
          The healthcare section that contains all applicable
          healthcare-qualified amounts. <a
          href='https://triposcert.vantiv.com/api/help/kb/healthcare.html'>more&raquo;</a>
      laneId:
        description: Specifies which lane to use for the card sale.
        format: int32
        type: integer
      referenceNumber:
        description: A user defined reference number.
        type: string
      shiftId:
        description: An optional shift id for reference.
        type: string
      ticketNumber:
        description: An optional ticket number.
        type: string
      tipAmount:
        description: >-
          The tip amount of the transaction. This amount is added to the
          TotalAmount before the cardholder is charged.
        format: double
        type: number
      tokenId:
        description: The token ID used for the sale.
        type: string
      tokenProvider:
        description: The type of token ID used for the sale.
        type: string
      transactionAmount:
        description: >-
          The total transaction amount. This is the amount of funds to move on
          the card
        format: double
        type: number
      vaultId:
        description: The Vault ID used to create the token.
        type: string
    required:
      - cardLogo
      - laneId
      - tokenId
      - tokenProvider
      - transactionAmount
      - vaultId
  TokenAuthorizationResponse:
    description: TokenAuthorizationResponse
    properties:
      _errors:
        description: A list of errors that occurred.
        items:
          $ref: '#/definitions/ApiError'
        type: array
      _hasErrors:
        description: Indicates if there are errors.
        type: boolean
      _links:
        description: A list of resource links
        items:
          $ref: '#/definitions/ApiLink'
        type: array
      _logs:
        description: >-
          A list of log entries detailing what happened during the request.
          Ideally only used during development or troubleshooting as this can be
          quite verbose.
        items:
          type: string
        type: array
      _processor:
        $ref: '#/definitions/Processor'
        description: Response information from the processor.
      _type:
        description: The type of object held in the result.
        type: string
      _warnings:
        description: A list of warnings that occurred.
        items:
          $ref: '#/definitions/ApiWarning'
        type: array
      accountNumber:
        description: The card account number.
        type: string
      approvalNumber:
        description: >-
          Approval number from the processor. Depending on card type and
          processor an approval number might not be returned.
        type: string
      approvedAmount:
        description: >-
          The amount approved by the processor. This is the actual amount that
          will be charged or credited.
        format: double
        type: number
      avsResponseCode:
        description: The AVS response code.
        type: string
      cardLogo:
        description: >-
          The card logo. Possible values are: Visa, Mastercard, Discover, Amex,
          Diners Club, JCB, Carte Blanche, Other.
        type: string
      convenienceFeeAmount:
        description: The convenience fee added to the transaction
        format: double
        type: number
      creditSurchargeAmount:
        description: The credit surcharge added to the transaction
        format: double
        type: number
      isApproved:
        description: Set to true if the host approved the transaction.
        type: boolean
      isOffline:
        description: >-
          A boolean value indicating whether triPOS is disconnected from the
          host.
        type: boolean
      merchantId:
        description: The Merchant used to process the transaction.
        type: string
      referenceNumber:
        description: The reference number.
        type: string
      statusCode:
        description: The status code for the transaction.
        type: string
      subTotalAmount:
        description: The original amount sent for the transaction.
        format: double
        type: number
      terminalId:
        description: The ID of the terminal used during the transaction
        type: string
      tipAmount:
        description: The tip amount added to the transaction.
        format: double
        type: number
      tokenId:
        description: The token ID.
        type: string
      totalAmount:
        description: The total amount of the transaction.
        format: double
        type: number
      transactionDateTime:
        description: Transaction date/time in ISO8601 format
        type: string
      transactionId:
        description: The transaction ID from the processor
        type: string
  TokenRefundRequest:
    description: TokenRefundRequest
    properties:
      cardLogo:
        description: The card logo of the card that the token represents.
        type: string
      clerkNumber:
        description: An optional clerk number for reference.
        type: string
      configuration:
        $ref: '#/definitions/POST_RequestConfiguration_v1_refund_token'
        description: >-
          Any value included in this section will override the corresponding
          value set in the triPOS.config
      convenienceFeeAmount:
        description: >-
          The convenience fee amount of the transaction. This amount is added to
          the TotalAmount before the cardholder is charged
        format: double
        type: number
      expirationMonth:
        description: >-
          The expiration month of the card the token represents. Although this
          is not required, it is recommended for fraud protection.
        type: string
      expirationYear:
        description: >-
          The expiration year of the card the token represents. Although this is
          not required, it is recommended for fraud protection.
        type: string
      laneId:
        description: Specifies which lane to use for the card sale.
        format: int32
        type: integer
      referenceNumber:
        description: A user defined reference number.
        type: string
      shiftId:
        description: An optional shift id for reference.
        type: string
      ticketNumber:
        description: An optional ticket number.
        type: string
      tokenId:
        description: The token ID used for the sale.
        type: string
      tokenProvider:
        description: The type of token ID used for the sale.
        type: string
      transactionAmount:
        description: >-
          The total transaction amount. This is the amount of funds to move on
          the card
        format: double
        type: number
      vaultId:
        description: The Vault ID used to create the token.
        type: string
    required:
      - cardLogo
      - laneId
      - tokenId
      - tokenProvider
      - transactionAmount
      - vaultId
  TokenRefundResponse:
    description: TokenRefundResponse
    properties:
      _errors:
        description: A list of errors that occurred.
        items:
          $ref: '#/definitions/ApiError'
        type: array
      _hasErrors:
        description: Indicates if there are errors.
        type: boolean
      _links:
        description: A list of resource links
        items:
          $ref: '#/definitions/ApiLink'
        type: array
      _logs:
        description: >-
          A list of log entries detailing what happened during the request.
          Ideally only used during development or troubleshooting as this can be
          quite verbose.
        items:
          type: string
        type: array
      _processor:
        $ref: '#/definitions/Processor'
        description: Response information from the processor.
      _type:
        description: The type of object held in the result.
        type: string
      _warnings:
        description: A list of warnings that occurred.
        items:
          $ref: '#/definitions/ApiWarning'
        type: array
      approvalNumber:
        description: >-
          Approval number from the processor. Depending on card type and
          processor an approval number might not be returned.
        type: string
      cardLogo:
        description: >-
          The card logo. Possible values are: Visa, Mastercard, Discover, Amex,
          Diners Club, JCB, Carte Blanche, Other.
        type: string
      convenienceFeeAmount:
        description: The convenience fee added to the transaction
        format: double
        type: number
      isApproved:
        description: Set to true if the host approved the transaction.
        type: boolean
      isOffline:
        description: >-
          A boolean value indicating whether triPOS is disconnected from the
          host.
        type: boolean
      merchantId:
        description: The Merchant used to process the transaction.
        type: string
      referenceNumber:
        description: The reference number.
        type: string
      statusCode:
        description: The status code for the transaction.
        type: string
      terminalId:
        description: The ID of the terminal used during the transaction
        type: string
      tokenId:
        description: The token ID.
        type: string
      totalAmount:
        description: The total amount of the transaction.
        format: double
        type: number
      transactionDateTime:
        description: Transaction date/time in ISO8601 format
        type: string
      transactionId:
        description: The transaction ID from the processor
        type: string
  TokenRequestConfiguration:
    description: TokenRequestConfiguration
    properties:
      cardReadRetries:
        description: "Number of retries in case of bad card read. The\_default\_value\_is\_1."
        format: int32
        type: integer
  TokenSaleRequest:
    description: TokenSaleRequest
    properties:
      address:
        $ref: '#/definitions/POST_Address_v1_sale_token'
        description: The cardholder address information for the transaction.
      autoRental:
        $ref: '#/definitions/POST_AutoRental_v1_sale_token'
        description: >-
          The auto rental parameters to be passed in for an auto rental
          transaction. <a href='https://triposcert.vantiv.com/api/help/kb/autorental.html'>more&raquo;</a>
      cardLogo:
        description: The card logo of the card that the token represents.
        type: string
      clerkNumber:
        description: An optional clerk number for reference.
        type: string
      configuration:
        $ref: '#/definitions/POST_RequestConfiguration_v1_sale_token'
        description: >-
          Any value included in this section will override the corresponding
          value set in the triPOS.config
      convenienceFeeAmount:
        description: >-
          The convenience fee amount of the transaction. This amount is added to
          the TotalAmount before the cardholder is charged
        format: double
        type: number
      creditSurchargeAmount:
        description: >-
          The credit surcharge amount of the transaction. This amount is added
          to the TotalAmount before the cardholder is charged
        format: double
        type: number
      estimatedAmountIndicator:
        description: >-
          The EstimatedAmountIndicator can be used by merchants/integrators to
          define the TransactionAmount submitted to Express either as an
          Estimated Amount (i.e. amount to charge cardholder may change) or a
          Final Amount (i.e. amount to charge cardholder will not change).  It
          will be a 1-character request field supporting the following request
          settings:
        type: string
      expirationMonth:
        description: >-
          The expiration month of the card the token represents. Although this
          is not required, it is recommended for fraud protection.
        type: string
      expirationYear:
        description: >-
          The expiration year of the card the token represents. Although this is
          not required, it is recommended for fraud protection.
        type: string
      healthcare:
        $ref: '#/definitions/POST_Healthcare_v1_sale_token'
        description: >-
          The healthcare section that contains all applicable
          healthcare-qualified amounts. <a
          href='https://triposcert.vantiv.com/api/help/kb/healthcare.html'>more&raquo;</a>
      laneId:
        description: Specifies which lane to use for the card sale.
        format: int32
        type: integer
      referenceNumber:
        description: A user defined reference number.
        type: string
      shiftId:
        description: An optional shift id for reference.
        type: string
      ticketNumber:
        description: An optional ticket number.
        type: string
      tipAmount:
        description: >-
          The tip amount of the transaction. This amount is added to the
          TotalAmount before the cardholder is charged.
        format: double
        type: number
      tokenId:
        description: The token ID used for the sale.
        type: string
      tokenProvider:
        description: The type of token ID used for the sale.
        type: string
      transactionAmount:
        description: >-
          The total transaction amount. This is the amount of funds to move on
          the card
        format: double
        type: number
      vaultId:
        description: The Vault ID used to create the token.
        type: string
    required:
      - cardLogo
      - laneId
      - tokenId
      - tokenProvider
      - transactionAmount
      - vaultId
  TokenSaleResponse:
    description: TokenSaleResponse
    properties:
      _errors:
        description: A list of errors that occurred.
        items:
          $ref: '#/definitions/ApiError'
        type: array
      _hasErrors:
        description: Indicates if there are errors.
        type: boolean
      _links:
        description: A list of resource links
        items:
          $ref: '#/definitions/ApiLink'
        type: array
      _logs:
        description: >-
          A list of log entries detailing what happened during the request.
          Ideally only used during development or troubleshooting as this can be
          quite verbose.
        items:
          type: string
        type: array
      _processor:
        $ref: '#/definitions/Processor'
        description: Response information from the processor.
      _type:
        description: The type of object held in the result.
        type: string
      _warnings:
        description: A list of warnings that occurred.
        items:
          $ref: '#/definitions/ApiWarning'
        type: array
      accountNumber:
        description: The card account number.
        type: string
      approvalNumber:
        description: >-
          Approval number from the processor. Depending on card type and
          processor an approval number might not be returned.
        type: string
      approvedAmount:
        description: >-
          The amount approved by the processor. This is the actual amount that
          will be charged or credited.
        format: double
        type: number
      avsResponseCode:
        description: The AVS response code.
        type: string
      cardLogo:
        description: >-
          The card logo. Possible values are: Visa, Mastercard, Discover, Amex,
          Diners Club, JCB, Carte Blanche, Other.
        type: string
      convenienceFeeAmount:
        description: The convenience fee added to the transaction
        format: double
        type: number
      creditSurchargeAmount:
        description: The credit surcharge added to the transaction
        format: double
        type: number
      isApproved:
        description: Set to true if the host approved the transaction.
        type: boolean
      isOffline:
        description: >-
          A boolean value indicating whether triPOS is disconnected from the
          host.
        type: boolean
      merchantId:
        description: The Merchant used to process the transaction.
        type: string
      referenceNumber:
        description: The reference number.
        type: string
      statusCode:
        description: The status code for the transaction.
        type: string
      subTotalAmount:
        description: The original amount sent for the transaction.
        format: double
        type: number
      terminalId:
        description: The ID of the terminal used during the transaction
        type: string
      tipAmount:
        description: The tip amount added to the transaction.
        format: double
        type: number
      tokenId:
        description: The token ID.
        type: string
      totalAmount:
        description: The total amount of the transaction.
        format: double
        type: number
      transactionDateTime:
        description: Transaction date/time in ISO8601 format
        type: string
      transactionId:
        description: The transaction ID from the processor
        type: string
  TransactionIdRequestConfiguration:
    description: TransactionIdRequestConfiguration
    properties:
      marketCode:
        description: 'The market code of the transaction. '
        type: string
  TransactionQueryRequest:
    description: TransactionQueryRequest
    properties:
      approvalNumber:
        description: Approval number
        type: string
      approvedAmount:
        description: Amount approved by the transaction.
        format: double
        type: number
      expressTransactionDate:
        description: Express transaction date formatted YYYMMDD
        type: string
      expressTransactionTime:
        description: Express transaction time formatted HHMMSS
        type: string
      hostBatchId:
        description: Unique host batch identifier
        type: string
      hostItemId:
        description: Unique host batch reference number
        type: string
      referenceNumber:
        description: A user defined reference number.
        type: string
      reverseOrder:
        description: Flag to query records in descending order
        type: string
      shiftId:
        description: An optional shift id for reference.
        type: string
      terminalId:
        description: Terminal identifier
        type: string
      trackingId:
        description: Internal transaction tracking identifier
        type: string
      transactionAmount:
        description: Transaction amount
        format: double
        type: number
      transactionDateTimeBegin:
        description: >-
          Begin date/time of transaction range. Required if TransactionID or
          TransactionSetupID is not included. Format "YYYY-MM-DD HH:MM:SS"
        type: string
      transactionDateTimeEnd:
        description: >-
          End date/time of transaction range. Required if TransactionID or
          TransactionSetupID is not included. Format "YYYY-MM-DD HH:MM:SS"
        type: string
      transactionId:
        description: TransactionID returned in original transaction.
        type: string
      transactionSetupId:
        description: Transaction setup ID
        type: string
      transactionStatusCode:
        description: Transaction status code
        type: string
      transactionType:
        description: Transaction type
        type: string
    required:
      - approvalNumber
      - referenceNumber
      - terminalId
      - transactionDateTimeBegin
      - transactionDateTimeEnd
      - transactionId
  TransactionQueryResponse:
    description: TransactionQueryResponse
    properties:
      _errors:
        description: A list of errors that occurred.
        items:
          $ref: '#/definitions/ApiError'
        type: array
      _hasErrors:
        description: Indicates if there are errors.
        type: boolean
      _links:
        description: A list of resource links
        items:
          $ref: '#/definitions/ApiLink'
        type: array
      _logs:
        description: >-
          A list of log entries detailing what happened during the request.
          Ideally only used during development or troubleshooting as this can be
          quite verbose.
        items:
          type: string
        type: array
      _type:
        description: The type of object held in the result.
        type: string
      _warnings:
        description: A list of warnings that occurred.
        items:
          $ref: '#/definitions/ApiWarning'
        type: array
      reportingData:
        description: Transaction information. A maximum of 1000 records can be returned.
        items:
          $ref: '#/definitions/ReportingDataItemDto'
        type: array
  TriPosStatusRequest:
    description: TriPosStatusRequest
  TriPosStatusResponse:
    description: TriPosStatusResponse
    properties:
      _type:
        description: The type of object held in the result.
        type: string
      echo:
        description: Provided text to be echoed back in the response.
        type: string
  UnloadGiftRequest:
    description: UnloadGiftRequest
    properties:
      cardHolderPresentCode:
        description: >-
          Defines whether the cardholder is present at the transaction. This
          value is optional, but recommended to be set. If this value is not set
          in the request, it will be automatically set based on the market code.
        type: string
      clerkNumber:
        description: An optional clerk number for reference.
        type: string
      configuration:
        $ref: '#/definitions/POST_RequestConfiguration_v1_gift_unload'
        description: >-
          Any value included in this section will override the corresponding
          value set in the triPOS.config
      invokeManualEntry:
        description: ' Invokes manual card entry.'
        type: boolean
      isCscSupported:
        description: >-
          Invokes prompt for cardholder to enter card security code for manual
          keyed card entry.
        type: string
      laneId:
        description: Specifies which lane to use.
        format: int32
        type: integer
      referenceNumber:
        description: A user defined reference number.
        type: string
      shiftId:
        description: An optional shift id for reference.
        type: string
      storeCard:
        $ref: '#/definitions/POST_StoreCard_v1_gift_unload'
        description: Information necessary to process a StoreCard transaction.
      ticketNumber:
        description: An optional ticket number.
        type: string
      transactionAmount:
        description: >-
          The total transaction amount. This is the amount of funds to move on
          the card
        format: double
        type: number
    required:
      - laneId
      - transactionAmount
  UnloadGiftResponse:
    description: UnloadGiftResponse
    properties:
      _errors:
        description: A list of errors that occurred.
        items:
          $ref: '#/definitions/ApiError'
        type: array
      _hasErrors:
        description: Indicates if there are errors.
        type: boolean
      _links:
        description: A list of resource links
        items:
          $ref: '#/definitions/ApiLink'
        type: array
      _logs:
        description: >-
          A list of log entries detailing what happened during the request.
          Ideally only used during development or troubleshooting as this can be
          quite verbose.
        items:
          type: string
        type: array
      _processor:
        $ref: '#/definitions/Processor'
        description: Response information from the processor.
      _type:
        description: The type of object held in the result.
        type: string
      _warnings:
        description: A list of warnings that occurred.
        items:
          $ref: '#/definitions/ApiWarning'
        type: array
      accountNumber:
        description: The card account number.
        type: string
      approvalNumber:
        description: >-
          Approval number from the processor. Depending on card type and
          processor an approval number might not be returned.
        type: string
      approvedAmount:
        description: The amount approved for the transaction.
        format: double
        type: number
      balanceAmount:
        description: The balance of the gift card.
        format: double
        type: number
      balanceCurrencyCode:
        description: The balance currency code.
        type: string
      binAttributes:
        $ref: '#/definitions/Dictionary_String_Boolean'
        description: >-
          Available binAttributes of card. <a
          href='https://triposcert.vantiv.com/api/help/kb/cardBinAttributes.html'>more&raquo;</a>
      binValue:
        description: The BIN entry that matched the account number.
        type: string
      cardLogo:
        description: 'The card logo (e.g. Visa, Mastercard, etc).'
        type: string
      entryMode:
        description: 'Description of how card was entered: Keyed, Swiped, Chip.'
        type: string
      isApproved:
        description: Set to true if the host approved the transaction.
        type: boolean
      isOffline:
        description: >-
          A boolean value indicating whether triPOS is disconnected from the
          host.
        type: boolean
      merchantId:
        description: The Merchant used to process the transaction.
        type: string
      statusCode:
        description: The status code for the transaction.
        type: string
      terminalId:
        description: The ID of the terminal used during the transaction
        type: string
      totalAmount:
        description: The total amount of the transaction.
        format: double
        type: number
      transactionDateTime:
        description: Transaction date/time in ISO8601 format
        type: string
      transactionId:
        description: The transaction ID from the processor
        type: string
  UpdatePaymentAccountCreditRequest:
    description: UpdatePaymentAccountCreditRequest
    properties:
      address:
        $ref: '#/definitions/PUT_Address_v1_paymentAccount_paymentAccountId_credit'
        description: The cardholder address information for the transaction.
      configuration:
        $ref: >-
          #/definitions/PUT_TokenRequestConfiguration_v1_paymentAccount_paymentAccountId_credit
        description: >-
          Any value included in this section will override the corresponding
          value set in the triPOS.config
      expirationMonth:
        description: The expiration month.
        type: string
      expirationYear:
        description: The expiration year.
        type: string
      invokeManualEntry:
        description: ' Invokes manual card entry.'
        type: boolean
      laneId:
        description: The Lane ID.
        format: int32
        type: integer
      paymentAccountReferenceNumber:
        description: The payment account reference number
        type: string
      updateCardData:
        description: >-
          The value that is passed in for UpdateCardData. Should be true or
          false.
        type: boolean
    required:
      - laneId
      - paymentAccountReferenceNumber
      - updateCardData
  UpdatePaymentAccountCreditResponse:
    description: UpdatePaymentAccountCreditResponse
    properties:
      _errors:
        description: A list of errors that occurred.
        items:
          $ref: '#/definitions/ApiError'
        type: array
      _hasErrors:
        description: Indicates if there are errors.
        type: boolean
      _links:
        description: A list of resource links
        items:
          $ref: '#/definitions/ApiLink'
        type: array
      _logs:
        description: >-
          A list of log entries detailing what happened during the request.
          Ideally only used during development or troubleshooting as this can be
          quite verbose.
        items:
          type: string
        type: array
      _processor:
        $ref: '#/definitions/Processor'
        description: Response information from the processor.
      _type:
        description: The type of object held in the result.
        type: string
      _warnings:
        description: A list of warnings that occurred.
        items:
          $ref: '#/definitions/ApiWarning'
        type: array
      accountNumber:
        description: >-
          The credit card number with the value masked except for the last 4.
          This field is only available when <code>updateCardData</code> is set
          to true in the request.
        type: string
      approvalNumber:
        description: >-
          Approval number from the processor. Depending on card type and
          processor an approval number might not be returned.
        type: string
      binAttributes:
        $ref: '#/definitions/Dictionary_String_Boolean'
        description: >-
          Available binAttributes of card. <a
          href='https://triposcert.vantiv.com/api/help/kb/cardBinAttributes.html'>more&raquo;</a>
      binValue:
        description: >-
          The BIN entry that matched the account number. This field is only
          available when <code>updateCardData</code> is set to true in the
          request.
        type: string
      cardHolderName:
        description: >-
          The cardholder name. This field is only available when
          <code>updateCardData</code> is set to true in the request.
        type: string
      cardLogo:
        description: >-
          The card logo. Possible values are: Visa, Mastercard, Discover, Amex,
          Diners Club, JCB, Carte Blanche, Other. This field is only available
          when <code>updateCardData</code> is set to true in the request.
        type: string
      entryMode:
        description: >-
          Description of how card was entered. This field is only available when
          <code>updateCardData</code> is set to true in the request.
        type: string
      expirationMonth:
        description: >-
          The card's expiration month. This field is only available when
          <code>updateCardData</code> is set to true in the request.
        type: string
      expirationYear:
        description: >-
          The card's expiration year. This field is only available when
          <code>updateCardData</code> is set to true in the request.
        type: string
      fsaCard:
        description: >-
          Indicates whether the card used was a FSA card. This field is only
          available when <code>updateCardData</code> is set to true in the
          request.<br />Note: Maybe = No BIN entry to determine if FSA.
        type: string
      isApproved:
        description: Set to true if the host approved the transaction.
        type: boolean
      isOffline:
        description: >-
          A boolean value indicating whether triPOS is disconnected from the
          host.
        type: boolean
      merchantId:
        description: The Merchant used to process the transaction.
        type: string
      paymentAccountId:
        description: the payment account ID.
        type: string
      paymentAccountReferenceNumber:
        description: the payment account reference number.
        type: string
      statusCode:
        description: The status code for the transaction.
        type: string
      terminalId:
        description: The ID of the terminal used during the transaction.
        type: string
      transactionDateTime:
        description: Transaction date/time in ISO8601 format
        type: string
      transactionId:
        description: The transaction ID from the processor
        type: string
  VoidRequest:
    description: VoidRequest
    properties:
      cardHolderPresentCode:
        description: >-
          Defines whether the cardholder is present at the transaction. This
          value is optional, but recommended to be set. If this value is not set
          in the request, it will be automatically set based on the market code.
        type: string
      clerkNumber:
        description: An optional clerk number for reference.
        type: string
      configuration:
        $ref: >-
          #/definitions/POST_TransactionIdRequestConfiguration_v1_void_transactionId
        description: >-
          Any value included in this section will override the corresponding
          value set in the triPOS.config
      laneId:
        description: Specifies which lane to use.
        format: int32
        type: integer
      referenceNumber:
        description: A user defined reference number.
        type: string
      shiftId:
        description: An optional shift id for reference.
        type: string
      ticketNumber:
        description: An optional ticket number.
        type: string
    required:
      - laneId
  VoidResponse:
    description: VoidResponse
    properties:
      _errors:
        description: A list of errors that occurred.
        items:
          $ref: '#/definitions/ApiError'
        type: array
      _hasErrors:
        description: Indicates if there are errors.
        type: boolean
      _links:
        description: A list of resource links
        items:
          $ref: '#/definitions/ApiLink'
        type: array
      _logs:
        description: >-
          A list of log entries detailing what happened during the request.
          Ideally only used during development or troubleshooting as this can be
          quite verbose.
        items:
          type: string
        type: array
      _processor:
        $ref: '#/definitions/Processor'
        description: Response information from the processor.
      _type:
        description: The type of object held in the result.
        type: string
      _warnings:
        description: A list of warnings that occurred.
        items:
          $ref: '#/definitions/ApiWarning'
        type: array
      accountNumber:
        description: The Account Number returned by the host
        type: string
      approvalNumber:
        description: >-
          Approval number from the processor. Depending on card type and
          processor an approval number might not be returned.
        type: string
      cardLogo:
        description: >-
          The card logo. Possible values are: Visa, Mastercard, Discover, Amex,
          Diners Club, JCB, Carte Blanche, Other
        type: string
      isApproved:
        description: Set to true if the host approved the transaction.
        type: boolean
      isOffline:
        description: >-
          A boolean value indicating whether triPOS is disconnected from the
          host.
        type: boolean
      merchantId:
        description: The Merchant used to process the transaction.
        type: string
      statusCode:
        description: The status code for the transaction.
        type: string
      terminalId:
        description: The ID of the terminal used during the transaction
        type: string
      transactionDateTime:
        description: Transaction date/time in ISO8601 format
        type: string
      transactionId:
        description: The transaction ID from the processor
        type: string

