FiservRapidConnectOnboardRequest

Create a FiservRapidConnect 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.

  • mcc
    Type: string · Mcc
    required

    Four-digit merchant category code.

  • processor_config_id
    Type: string · Processor Config Id
    required

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

  • var_sheet
    Type: object · FiservVarSheet
    required

    Generic RapidConnect VAR sheet, including required address and industry.

    • industry
      Type: string · FiservIndustryenum
      required

      Merchant industry. Use the value assigned for this configuration.

      values
      • retail_qsr_grocery
      • restaurant
      • ecommerce
      • moto
      • supermarket
    • merchant_city
      Type: string · Merchant City
      min length:  
      1
      required

      Merchant city.

    • merchant_postal_code
      Type: string · Merchant Postal Code
      min length:  
      1
      required

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

    • merchant_state
      Type: string · Merchant State
      min length:  
      1
      required

      Two-letter state code for a US address.

    • merchant_street_address
      Type: string · Merchant Street Address
      min length:  
      1
      required

      Merchant street address.

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

    • datawire_enabled
      Type: boolean · Datawire Enabled

      Enable Datawire for this terminal. Supplying did enables it automatically.

    • did
      Type: string · Didnullable

      Assigned Datawire ID, when applicable.

    • equipment
      Type: string · FiservEquipmentenumnullable

      Equipment value assigned for this configuration.

      values
      • CreditCallHCRC
      • CREDITCALLHCRC
      • CreditCallHCECRC
      • CreditCallLTDGTWRC
      • CRDCallResellerRCSS
    • group_id
      Type: string · Group Idnullable

      Group ID assigned with the merchant's processor identifiers.

    • merchant_street_address2
      Type: string · Merchant Street Address2nullable

      Merchant street address line 2.

    • settlement_mid
      Type: string · Settlement Midnullable

      North Settlement Merchant ID (the 12-digit North Settlement MID from the VAR sheet). Type: string or null. Optional — used by the North-settling variants (Cardnet North, Nashville North). If omitted it is populated on the backend.

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

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