TSYSOnboardResponse

  • terminal
    Type: object · TerminalConfig
    required
    • 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_rate
      Type: number | null · Surcharge Rate

      Surcharge percentage (e.g., 3.5 for 3.5%). Setting to null disables automatic surcharge logic. Setting to 0 means surcharges will NEVER be applied unless explicitly overridden.

    • 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
  • location
    Type: object · LocationBase nullable
    • account_id
      Type: string · Account Id
      required
    • id
      Type: string · Id
      required
    • name
      Type: string · Name
      required
    • address
      Type: object · Address nullable
    • country_code
      Type: string | null · Country Code
    • created_at
      Type: string | null · Created AtFormat: date-time

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

    • currency
      Type: string | null · Currency
    • 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

    • email
      Type: string | null · Email
    • metadata
      Type: object | null · Metadata
    • phone
      Type: string | null · Phone
    • processor_config_id
      Type: string | null · Processor Config Id
    • status
      Type: string · Status
    • surcharge_rate
      Type: number | null · Surcharge Rate

      Surcharge percentage (e.g., 3.5 for 3.5%). Setting to null disables automatic surcharge logic. Setting to 0 means surcharges will NEVER be applied unless explicitly overridden.

    • terminal_id
      Type: string | null · Terminal Id
    • 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