TSYSOnboardRequest

Create a TSYS terminal with POST /v2/terminals. Use the identifiers assigned to your merchant.

  • account_id
    Type: string
    required

    The merchant account ID being boarded.

  • processor_config_id
    Type: string
    required

    ID of the processor configuration selected from GET /v1/processor-configs.

  • var_sheet
    Type:
    required

    TSYS VAR sheet. Required for a TSYS board.

    Properties: 23
  • batch_schedule
    Type: Batch Schedulenullable

    Optional automatic batch schedule with timezone, is_active and schedule. Availability depends on the processor configuration.

    Properties: 1
  • description
    Type: stringnullable

    Optional terminal description. terminal_description is also accepted.

  • mcc
    Type: stringnullable

    Four-digit merchant category code.

  • merchant_name
    Type: stringnullable

    Merchant name. Used by Silverflow acceptor creation; when omitted, Silverflow falls back to top-level name, then the merchant account name.

  • mid
    Type: stringnullable

    Merchant identifier assigned for this processor configuration. Preserve leading zeros.

  • name
    Type: stringnullable

    Terminal display name. terminal_name is also accepted.

  • 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
  • tid
    Type: stringnullable

    Terminal identifier assigned for this processor configuration. Preserve leading zeros.