LocationUpdate

  • address
    Type: object · Addressnullable
    • city
      Type: string · City
      required
    • state
      Type: string · State
      required
    • street_line1
      Type: string · Street Line1
      required
    • zip
      Type: string · Zip
      required
    • street_line2
      Type: string · Street Line2
  • country_code
    Type: string | null · Country Code
  • currency
    Type: string | null · Currency
  • email
    Type: string | null · Email
  • metadata
    Type: object | null · Metadata
  • name
    Type: string | null · Name
  • phone
    Type: string | null · Phone
  • processor_config_id
    Type: string | null · Processor Config Id
  • status
    Type: string | null · Status
  • surcharge_basis
    Type: string | null · Surcharge Basis

    What the surcharge is calculated on. Resolved most-specific-first: terminal, then location, then account. A null at the terminal or location level inherits from the level above; a null at the account level leaves it unset.

  • surcharge_confirmation_required
    Type: boolean | null · Surcharge Confirmation Required

    Whether the cardholder must confirm the surcharge before the sale proceeds. When true, sale/preauth returns a surcharge-pending state that must be confirmed before the transaction completes. Resolved most-specific-first: terminal, then location, then account. A null at the terminal or location level inherits from the level above; a null at the account level defaults to no confirmation.

  • surcharge_rate
    Type: number | null · Surcharge Rate

    Surcharge percentage (e.g., 3.5 for 3.5%). Resolved most-specific-first: terminal, then location, then account. A null at the terminal or location level inherits the value from the level above; a null at the account (root) level disables automatic surcharge logic (no surcharge is applied). 0 means surcharges are never applied unless explicitly overridden.

  • tax_basis
    Type: string | null · Tax Basis

    What the tax is calculated on. Resolved most-specific-first: terminal, then location, then account. A null at the terminal or location level inherits from the level above; a null at the account level leaves it unset.

  • tax_rate
    Type: number | null · Tax Rate

    Tax percentage (e.g., 8.25 for 8.25%). Resolved most-specific-first: terminal, then location, then account. A null at the terminal or location level inherits from the level above; a null at the account level disables tax defaults.

  • terminal_id
    Type: string | null · Terminal Id