PaginatedTerminals

Paginated terminals response payload.

  • limit
    Type: integer · Limit
    required

    Maximum items returned in this page

  • offset
    Type: integer · Offset
    required

    Number of items skipped before this page

  • page
    Type: integer · Page
    required

    Current page number (1-indexed)

  • terminals
    Type: array object[] · Terminals
    required

    List of terminal configurations

    • account_id
      Type: string · Account Id
      required
    • created_at
      Type: string · Created AtFormat: date-time
      required

      the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

    • mid
      Type: string · Mid
      required
    • name
      Type: string · Name
      required
    • processor_config_id
      Type: string · Processor Config Id
      required
    • terminal_id
      Type: string · Terminal Id
      required
    • tid
      Type: string · Tid
      required
    • agent_bank_number
      Type: string | null · Agent Bank Number
    • bin
      Type: string | null · Bin
    • country_code
      Type: string | null · Country Code
    • currency_code
      Type: string | null · Currency Code
    • deleted_at
      Type: string | null · Deleted AtFormat: date-time

      the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

    • description
      Type: string | null · Description
    • merchant_category_code
      Type: string | null · Merchant Category Code
    • merchant_name
      Type: string | null · Merchant Name
    • serial_number
      Type: string | null · Serial Number
    • status
      Type: string · TerminalStatusenum
      values
      • active
      • inactive
      • blocked
    • surcharge_basis
      Type: string | null · Surcharge Basis

      What the surcharge is calculated on. Resolved most-specific-first: terminal, then location, then account. A null at the terminal or location level inherits from the level above; a null at the account level leaves it unset.

    • surcharge_confirmation_required
      Type: boolean | null · Surcharge Confirmation Required

      Whether the cardholder must confirm the surcharge before the sale proceeds. When true, sale/preauth returns a surcharge-pending state that must be confirmed before the transaction completes. Resolved most-specific-first: terminal, then location, then account. A null at the terminal or location level inherits from the level above; a null at the account level defaults to no confirmation.

    • surcharge_rate
      Type: number | null · Surcharge Rate

      Surcharge percentage (e.g., 3.5 for 3.5%). Resolved most-specific-first: terminal, then location, then account. A null at the terminal or location level inherits the value from the level above; a null at the account (root) level disables automatic surcharge logic (no surcharge is applied). 0 means surcharges are never applied unless explicitly overridden.

    • tax_basis
      Type: string | null · Tax Basis

      What the tax is calculated on. Resolved most-specific-first: terminal, then location, then account. A null at the terminal or location level inherits from the level above; a null at the account level leaves it unset.

    • tax_rate
      Type: number | null · Tax Rate

      Tax percentage (e.g., 8.25 for 8.25%). Resolved most-specific-first: terminal, then location, then account. A null at the terminal or location level inherits from the level above; a null at the account level disables tax defaults.

    • terminal_capability
      Type: string | null · Terminal Capability
    • transactions
      Type: array object[] · Transactions

      Model to represent a transaction

    • updated_at
      Type: string | null · Updated AtFormat: date-time

      the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

    • var_sheet
      Type: object | null · Var Sheet

      Processor-specific configuration (e.g., TSYS VAR sheet data)

    • vid
      Type: string | null · Vid
  • total
    Type: integer · Total
    required

    Total number of terminals available