AccountCreateRequest

Request to create an Account

  • business_profile
    Type: object · BusinessProfile
    • annual_revenue
      Type: object · AnnualRevenue

      The business's annual revenue.

    • estimated_worker_count
      Type: integer | null Format: int32

      The estimated number of workers in the business.

    • mcc
      Type: string | null

      Merchant Category Code

    • monthly_estimated_revenue
      Type: object · MonthlyEstimatedRevenue

      The business's estimated monthly revenue.

    • name
      Type: string | null

      The business name.

    • product_description
      Type: string | null

      A description of the products or services the business provides.

    • support_address

      The customer's address.

    • support_email
      Type: string | null

      The support email for the business.

    • support_phone
      Type: string | null

      The support phone number for the business.

    • support_url
      Type: string | null

      The support URL for the business.

    • url
      Type: string | null

      The business website.

  • business_type
    Type: string | null · BusinessTypeenum

    The business type.

    values
    • company
    • individual
    • non_profit
  • company
    Type: object · CompanyUpdate

    Company fields accepted when creating or updating an account.

    • address
      nullable

      The customer's address.

    • directors_provided
      Type: boolean

      Whether the company's directors have been provided.

    • executives_provided
      Type: boolean

      Whether the company's executives have been provided.

    • name
      Type: string | null

      The legal name of the company.

    • owners_provided
      Type: boolean

      Whether the company's owners have been provided.

    • phone
      Type: string | null

      The official business phone for verification and compliance.

    • registration_date
      Type: object · RegistrationDatenullable

      The date on which the company was incorporated or registered.

    • registration_number
      Type: string | null

      The company's registration number.

    • structure
      Type: string · CompanyStructureenumnullable

      The structure of the company.

      values
      • multi_member_llc
      • private_corporation
      • private_partnership
      • public_corporation
      • public_partnership
    • tax_id
      Type: string | null

      The company's tax identifier, as appropriate for its country.

    • tax_id_registrar
      Type: string | null

      The jurisdiction in which the tax ID is registered.

    • vat_id
      Type: string | null

      The company's VAT number.

  • country
    Type: string
  • default_currency
    Type: string · CurrencyCode

    ISO 4217 currency codes (alpha3) supported for payments

  • details_submitted
    Type: boolean
  • email
    Type: string
  • livemode
    Type: boolean

    Creates the account in live mode when true, or test mode when false.

  • metadata

    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

    • propertyName
      Type: string
  • tos_acceptance
    Type: object · tos_acceptance_specs

    Evidence of a declaration with timestamp, IP, and user agent

    • date
      Type: string Format: date-time

      The date and time when the declaration was made

    • ip
      Type: string

      The IP address from which the declaration was made

    • service_agreement
      Type: string
      max length:  
      100
    • user_agent
      Type: string

      The user agent of the browser/client making the declaration

  • type
    Type: string · AccountTypeenum

    The connected account type.

    values
    • custom

      The platform controls the connected account's integration and user experience.

    • express

      The account uses a Paypercut-assisted connected-account experience.

    • standard

      The account has direct access to its Paypercut account experience.