NeteviaOnboardRequest

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

  • account_id
    Type: string · Account Id
    required

    The merchant account ID being boarded.

  • processor_config_id
    Type: string · Processor Config Id
    required

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

  • var_sheet
    Type: object · TSYSVarSheet
    required

    TSYS VAR sheet. Required for a TSYS board.

    • acceptor_phone
      Type: string · Acceptor Phone
      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 · Acceptor Street Address
      required

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

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

      Six-digit acquirer BIN assigned in the VAR sheet.

    • city_code
      Type: string · City Code
      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 · Industry Code
      required

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

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

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

    • merchant_location
      Type: string · Merchant Location
      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 · Merchant Name
      required

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

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

      Twelve-digit merchant number assigned in the VAR sheet.

    • merchant_state
      Type: string · Merchant State
      required

      Two-letter state code for a US address.

    • store_number
      Type: string · Store Number
      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 · Terminal Number
      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: string · Acceptor Customer Service Phonenullable

      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: string · Authentication Codenullable

      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: string · Country Codenullable

      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 · Currency Code

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

    • endpoint
      Type: string · Endpointnullable

      Optional TSYS endpoint override. Type: string or null.

    • gen_key
      Type: string · Gen Keynullable

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

    • language_indicator
      Type: string · Language Indicator

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

    • merchant_street_address2
      Type: string · Merchant Street Address2nullable

      Merchant street address line 2.

    • override_gen_key
      Type: boolean · Override Gen Key
    • time_zone_diff
      Type: string · Time Zone Diff

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

    • propertyName
      Type: anything
  • batch_schedule
    Type: object · Batch Schedulenullable

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

    • propertyName
      Type: anything
  • description
    Type: string · Descriptionnullable

    Optional terminal description. terminal_description is also accepted.

  • mcc
    Type: string · Mccnullable

    Four-digit merchant category code.

  • merchant_name
    Type: string · Merchant Namenullable

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

  • mid
    Type: string · Midnullable

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

  • name
    Type: string · Namenullable

    Terminal display name. terminal_name is also accepted.

  • surcharge_basis
    Type: string · SurchargeBasisenumnullable

    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
    • total
    • subtotal
    • subtotal_plus_tax
    • subtotal_plus_tip
  • surcharge_confirmation_required
    Type: boolean · Surcharge Confirmation Requirednullable
  • surcharge_rate
    Type: number · Surcharge Ratenullable
  • tax_basis
    Type: string · TaxBasisenumnullable

    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
    • total
    • subtotal
  • tax_rate
    Type: number · Tax Ratenullable
  • tid
    Type: string · Tidnullable

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