TerminalConfig

  • 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: stringnullable
  • batching
    Type: Batchingnullable
    Properties: 1
  • bin
    Type: stringnullable
  • country_code
    Type: stringnullable
  • currency_code
    Type: stringnullable
  • deleted_at
    Type: stringFormat: date-timenullable

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

  • description
    Type: stringnullable
  • merchant_category_code
    Type: stringnullable
  • merchant_name
    Type: stringnullable
  • processor
    Type: stringnullable
  • serial_number
    Type: stringnullable
  • status
    Type: enum
    values
    activeinactiveblocked
  • surcharge_basis
    Type: enumnullable

    Amount used to calculate percentage-based surcharges. total uses subtotal, tax and tip; subtotal uses subtotal only; subtotal_plus_tax includes tax; subtotal_plus_tip includes tip. The basis is resolved from location, then terminal, then account, skipping null values. The default is total when no level configures a basis.

    values
    totalsubtotalsubtotal_plus_taxsubtotal_plus_tip
  • surcharge_confirmation_required
    Type: booleannullable
  • surcharge_rate
    Type: numbernullable
  • tax_basis
    Type: enumnullable

    Amount used to calculate percentage-based tax. total uses subtotal plus tip; subtotal uses subtotal only. Configure the default percentage with tax_rate. The basis is resolved from location, then terminal, then account, skipping null values. The default is total when no level configures a basis.

    values
    totalsubtotal
  • tax_rate
    Type: numbernullable
  • terminal_capability
    Type: stringnullable
  • transaction_stats
    Type: nullable

    Rolling 7-day transaction aggregates: the trailing 7 days (current) vs the 7 days before that (previous), for trend comparison.

    Populated only when a list endpoint is called with with_data=true (GET /v2/accounts and GET /v2/terminals); None otherwise.

    Properties: 2
  • transactions
    Type: array of Transaction
    Properties: 53
  • updated_at
    Type: stringFormat: date-timenullable

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

  • var_sheet
    Type: Var Sheetnullable
    Properties: 1
  • vid
    Type: stringnullable