AccountBase

  • address
    Type:
    required

    Postal address. Text is trimmed, and state and country codes are returned in uppercase.

    Properties: 6
  • created_at
    Type: stringFormat: date-time
    required

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

  • id
    Type: string
    required
  • name
    Type: string
    required
  • type
    Type: enum
    required
    values
    psppartnermerchant
  • available_processor_configs
    Type: array of string
  • available_processors
    Type: array of ProcessorConfigSummarynullable
    Properties: 12
  • children
    Type: array of AccountBase
    Properties: 21
  • deleted_at
    Type: stringFormat: date-timenullable

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

  • description
    Type: string
  • mcc
    Type: string | null

    Merchant accounts only.

  • parent_account_ids
    Type: array of string
  • status
    Type: enum
    values
    activeinactiveblocked
  • surcharge_basis
    Type: enumnullable

    Merchant accounts only.

    values
    totalsubtotalsubtotal_plus_taxsubtotal_plus_tip
  • surcharge_confirmation_required
    Type: boolean | null

    Merchant accounts only.

  • surcharge_rate
    Type: number | null

    Merchant accounts only.

  • tax_basis
    Type: enumnullable

    Merchant accounts only.

    values
    totalsubtotal
  • tax_id
    Type: string | null

    Merchant accounts only. Required on merchant creation; omit when creating a partner.

  • tax_rate
    Type: number | null

    Merchant accounts only.

  • transaction_stats
    Type: nullable

    Rolling 7-day transaction aggregates: the trailing 7 days (current) vs the 7 days before that (previous), for trend comparison.

    Populated only when a list endpoint is called with with_data=true (GET /v2/accounts and GET /v2/terminals); None otherwise.

    Properties: 2
  • updated_at
    Type: stringFormat: date-timenullable

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