TSYSVarSheet

TSYS boarding fields from the merchant's VAR sheet. Preserve assigned identifiers and leading zeros. Snake_case and camelCase inputs are accepted.

  • acceptor_phone
    Type: string
    required

    Merchant phone. Type: string normalized to exactly 10 digits (formatting such as dashes/parens/spaces is stripped, and a leading +1 / 1 US country code is removed). Aliases: acceptorPhone. Required.

  • acceptor_street_address
    Type: string
    required

    Merchant street address. Type: string. Aliases: acceptorStreetAddress, merchant_street_address, merchantStreetAddress.

  • acquirer_bin
    Type: string
    min length:  
    1
    required

    Six-digit acquirer BIN assigned in the VAR sheet.

  • city_code
    Type: string
    required

    Merchant ZIP / postal code. Type: string. Canonical TSYS field name is city_code (the value sent on auth + settlement). Aliases: cityCode, merchant_postal_code, merchantPostalCode. Note: despite the name, this is the postal/ZIP code, not a city.

  • industry_code
    Type: string
    required

    Industry code (e.g. 'R' = retail). Type: string. Aliases: industryCode.

  • merchant_category_code
    Type: string
    min length:  
    1
    required

    Merchant Category Code (ISO 18245). Type: numeric string, exactly 4 digits. Aliases: merchantCategoryCode.

  • merchant_location
    Type: string
    required

    Merchant city. Type: string. Canonical TSYS field name is merchant_location (the value sent on auth + settlement). Aliases: merchantLocation, merchant_city, merchantCity. Note: 'location' here means city, not a generic location.

  • merchant_name
    Type: string
    required

    Merchant (DBA) name. Type: string. Aliases: merchantName. Carried in the Card Acceptor Name/Location data.

  • merchant_number
    Type: string
    min length:  
    1
    required

    Twelve-digit merchant number assigned in the VAR sheet.

  • merchant_state
    Type: string
    required

    Two-letter state code for a US address.

  • store_number
    Type: string
    min length:  
    1
    required

    Four-digit store number assigned in the VAR sheet. Preserve leading zeros; 0001 is an example, not a default.

  • terminal_number
    Type: string
    min length:  
    1
    required

    Four-digit terminal number assigned in the VAR sheet. Preserve leading zeros; 0001 is an example, not a default.

  • acceptor_customer_service_phone
    Type: stringnullable

    Merchant customer-service phone. Type: string normalized to exactly 10 digits (same rules as acceptor_phone). Aliases: acceptorCustomerServicePhone. Optional — defaults to acceptor_phone when omitted, since the two are almost always identical.

  • authentication_code
    Type: stringnullable

    Terminal authentication code. Type: string or null. Aliases: authenticationCode. When present, Koard performs TSYS terminal authentication and mints the gen_key. Mutually exclusive with gen_key.

  • country_code
    Type: stringnullable

    ISO alpha-3 country, such as USA. US and 840 are also accepted as USA. Omitted or null country defaults to USA on create. Boarding is available only in the US.

  • currency_code
    Type: string

    Transaction currency (ISO 4217 numeric). Type: string. Default: '840' (USD). Aliases: currencyCode.

  • endpoint
    Type: stringnullable

    Optional TSYS endpoint override. Type: string or null.

  • gen_key
    Type: stringnullable

    Pre-issued TSYS gen key. Type: string or null. Aliases: genKey. Mutually exclusive with authentication_code (supplying both is rejected).

  • language_indicator
    Type: string

    TSYS language indicator. Type: string. Default: '00'. Aliases: languageIndicator.

  • merchant_street_address2
    Type: stringnullable

    Merchant street address line 2.

  • override_gen_key
    Type: boolean
  • time_zone_diff
    Type: string

    TSYS time-zone differential. Type: numeric string, exactly 3 digits (zero-padded; integers are accepted and coerced). Default: '705'. Aliases: timeZoneDiff.

  • propertyName
    additionalPropertyType: anything