TSYSOnboardRequest

  • account_id
    Type: string · Account ID
    required

    The merchant account ID

  • processor_config_id
    Type: string · Processor Config ID
    required

    TSYS processor configuration ID

  • terminal_name
    Type: string · Terminal Name
    required

    Display name for the terminal

  • var_sheet
    Type: object · TSYSVarSheet
    required
    • acceptor_customer_service_phone
      Type: string · Acceptor Customer Service Phone
      required

      Customer service phone number

    • acceptor_phone
      Type: string · Acceptor Phone
      required

      Phone number

    • acceptor_street_address
      Type: string · Acceptor Street Address
      required

      Street address

    • acquirer_bin
      Type: string · Acquirer BIN
      min length:  
      1
      required

      6-digit TSYS acquirer BIN

    • city_code
      Type: string · City Code
      required

      Postal/ZIP code

    • industry_code
      Type: string · Industry Code
      required

      Industry code (e.g., 'R' for Retail)

    • merchant_category_code
      Type: string · Merchant Category Code
      min length:  
      1
      required

      4-digit MCC

    • merchant_location
      Type: string · Merchant Location
      required

      Merchant city

    • merchant_name
      Type: string · Merchant Name
      required

      Merchant business name

    • merchant_number
      Type: string · Merchant Number
      min length:  
      1
      required

      12-digit TSYS merchant number

    • merchant_state
      Type: string · Merchant State
      required

      2-letter US state code

    • store_number
      Type: string · Store Number
      min length:  
      1
      required

      4-digit store number

    • terminal_number
      Type: string · Terminal Number
      min length:  
      1
      required

      4-digit terminal number

    • time_zone_diff
      Type: string · Time Zone Diff
      min length:  
      1
      required

      3-digit TSYS time zone code. 705 = EST, 706 = CST, 707 = MST, 708 = PST

    • authentication_code
      Type: string · Authentication Code nullable

      UAT only. Submit this code to TSYS to authenticate a terminal and receive a gen_key in return.

    • country_code
      Type: string · Country Code

      Country code (default 840 for US)

    • currency_code
      Type: string · Currency Code

      Currency code (default 840 for USD)

    • gen_key
      Type: string · Gen Key nullable

      The key returned after authenticating a terminal with authentication_code. Pass this on subsequent requests if you have previously authenticated a terminal.

    • language_indicator
      Type: string · Language Indicator

      Language indicator

  • terminal_description
    Type: string · Terminal Description nullable

    Optional description for the terminal