TerminalWithMetadata

Terminal configuration with optional metadata

  • account_id
    Type: string
    required
  • created_at
    Type: stringFormat: 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
    required
  • name
    Type: string
    required
  • processor_config_id
    Type: string
    required
  • terminal_id
    Type: string
    required
  • tid
    Type: string
    required
  • agent_bank_number
    Type: string | null
  • bin
    Type: string | null
  • country_code
    Type: string | null
  • currency_code
    Type: string | null
  • deleted_at
    Type: string | nullFormat: 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
  • merchant_category_code
    Type: string | null
  • merchant_name
    Type: string | null
  • metadata
    Type: object | null
  • serial_number
    Type: string | null
  • status
    Type: enum
    values
    activeinactiveblocked
  • surcharge_basis
    Type: string | nullenum

    Amount used to calculate percentage-based surcharges. Use the first non-null value from location, then terminal, then account. Defaults to total when all levels are null.

    values
    totalsubtotalsubtotal_plus_taxsubtotal_plus_tipnull
  • surcharge_confirmation_required
    Type: boolean | null

    Whether the cardholder must confirm the surcharge before the sale proceeds. Use the first non-null value from location, then terminal, then account. Defaults to no confirmation when all levels are null.

  • surcharge_rate
    Type: number | null

    Default surcharge percentage, such as 3.5 for 3.5%. Use the first non-null value from location, then terminal, then account. If all levels are null or the selected rate is zero, no default surcharge is applied.

  • tax_basis
    Type: "total" or "subtotal" or nullenum

    Amount used to calculate percentage-based tax. Use the first non-null value from location, then terminal, then account. Defaults to total (subtotal plus tip) when all levels are null. Use subtotal to exclude the tip.

  • tax_rate
    Type: number | null

    Default tax percentage, such as 8.25 for 8.25%. Use the first non-null value from location, then terminal, then account. If all levels are null or the selected rate is zero, no default tax is applied.

  • terminal_capability
    Type: string | null
  • transactions
    Type: array of Transaction
    Properties: 53
  • updated_at
    Type: string | nullFormat: date-time

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

  • vid
    Type: string | null