AccountBase

  • address
    Type: object · Address
    required
    • 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
  • created_at
    Type: string · Created AtFormat: date-time
    required

    the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

  • description
    Type: string · Description
    required
  • id
    Type: string · Id
    required
  • name
    Type: string · Name
    required
  • type
    Type: string · AccountTypeenum
    required
    values
    • psp
    • partner
    • merchant
  • available_processor_configs
    Type: array string[] · Available Processor Configs
  • deleted_at
    Type: string | null · Deleted AtFormat: date-time

    the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

  • has_access_to_apple_config
    Type: boolean · Has Access To Apple Config
  • mcc
    Type: string | null · Mcc
  • organization_id
    Type: string | null · Organization Id
  • parent_account_ids
    Type: array string[] · Parent Account Ids
  • status
    Type: string · AccountStatusenum
    values
    • active
    • inactive
    • blocked
  • 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_id
    Type: string | null · Tax Id
  • 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.

  • updated_at
    Type: string | null · Updated AtFormat: date-time

    the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z