SilverflowOnboardRequest

Create a Silverflow 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 · SilverflowVarSheet
    required

    Silverflow var_sheet. Required — supply acceptor_key to bind an existing acceptor, or the new-acceptor fields to create one.

    • acceptor_key
      Type: string · Acceptor Keynullable

      Existing Silverflow acceptor key (acpt-… / mac-…). Presence selects BIND mode: routing fields are read from the live acceptor. POS address fields can be supplied to configure its physical address.

    • bin_key
      Type: string · Bin Keynullable

      Silverflow acquiring-BIN key (bin-…) the acceptor sits under. REQUIRED in create mode.

    • description
      Type: string · Descriptionnullable

      Acceptor description. Optional — defaults to '{merchant_name} - {mid}' when omitted (create mode).

    • merchant_name
      Type: string · Merchant Name
      min length:  
      1      nullable

      Merchant's trading name. Input alias: name. Sent to Silverflow on POST and PUT. On bind, omission preserves the existing name. On create, omission falls back to top-level merchant_name, then top-level name, then the merchant account name. Returned as merchant_name.

    • point_of_sale_address
      Type: object · Point Of Sale Addressnullable

      Silverflow physical POS address (line1, city, postalCode, countryCode; optional line2/stateOrProvince). Required on the acceptor for POS. If omitted, use its existing address or the merchant account address. Shared flat merchant_* address fields are also accepted.

    • sub_merchant_id
      Type: string · Sub Merchant Idnullable

      Sub-merchant id (payfac / marketplace). Optional (create mode).

    • webshop_url
      Type: string · Webshop Urlnullable

      Merchant webshop URL. Optional (create mode).

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