TerminalConfigUpdateV2

Partial terminal update. Every field is optional. Send only changed fields, using canonical field names. Unknown fields are rejected. Do not send account_id, terminal_id or read-only response fields.

  • agent_bank_number
    Type: stringnullable
  • batch_schedule
    Type: Batch Schedulenullable

    For configurations with editable scheduling: supply timezone, is_active and schedule (day and times). Omit to preserve it; null removes it. Managed or unsupported schedules cannot be changed through this field.

    Properties: 1
  • bin
    Type: stringnullable
  • country_code
    Type: stringnullable

    Country code. Omit to preserve it; null becomes USA. US and 840 are accepted as USA.

  • currency_code
    Type: stringnullable
  • description
    Type: stringnullable

    Terminal description. Omit to preserve it; null clears it.

  • mcc
    Type: stringnullable

    Four-digit Merchant Category Code (ISO 18245). Omit to preserve the stored value; RapidConnect does not allow null.

  • mid
    Type: stringnullable

    Assigned merchant identifier. Keep it as a string, preserving leading zeros.

  • name
    Type: stringnullable

    Terminal display name. Omit to preserve the current name.

  • processor_config_id
    Type: stringnullable

    Replacement processor configuration ID available to this account. Changing it may perform boarding. Omission or null preserves the current configuration.

  • status
    Type: enumnullable
    values
    activeinactiveblocked
  • store_number
    Type: stringnullable
  • surcharge_basis
    Type: enumnullable

    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_tip
  • surcharge_confirmation_required
    Type: booleannullable

    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: numbernullable

    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: enumnullable

    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.

    values
    totalsubtotal
  • tax_rate
    Type: numbernullable

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

    Assigned terminal identifier. Keep it as a string, preserving leading zeros.

  • var_sheet
    Type: Var Sheetnullable

    Partial processor-specific update using fields from the selected configuration's boarding guide. Omission preserves all values; an object merges supplied keys. Null requests a clear, subject to required-field validation.

    Properties: 1
  • vid
    Type: stringnullable