ProPayOnboardRequest

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

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