ElavonViaConexOnboardRequest

Create a Elavon 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 · ElavonViaConexVarSheet
    required

    Elavon-specific extras (bank_number/terminal_number + merchant address/metadata). mid/tid/mcc are top-level.

    • acceptor_customer_service_phone
      Type: string · Acceptor Customer Service Phonenullable
    • acceptor_phone
      Type: string · Acceptor Phonenullable
    • bank_number
      Type: string · Bank Numbernullable

      Elavon Bank Number — digits 1-6 of the 22-digit Terminal_ID (exactly 6 digits). Supply with terminal_number to compose the Terminal_ID when the top-level tid is not supplied.

    • country_code
      nullable

      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.

      • Type: string · Country Code

        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 Codenullable

      Transaction currency (ISO 4217 numeric). Default '840'.

    • industry_code
      Type: string · Industry Codenullable
    • merchant_city
      Type: string · Merchant Citynullable

      Merchant city.

    • merchant_name
      Type: string · Merchant Namenullable
    • merchant_postal_code
      Type: string · Merchant Postal Codenullable

      Five-digit ZIP or ZIP+4 for a US address.

    • merchant_state
      Type: string · Merchant Statenullable

      Two-letter state code for a US address.

    • merchant_street_address
      Type: string · Merchant Street Addressnullable

      Merchant street address.

    • merchant_street_address2
      Type: string · Merchant Street Address2nullable

      Merchant street address line 2.

    • terminal_number
      Type: string · Terminal Numbernullable

      Elavon Terminal Number — digits 7-22 of the 22-digit Terminal_ID (exactly 16 digits). Supply with bank_number when the top-level tid is not supplied.

    • 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.