AccountBase

This is an object representing an account. You can retrieve it to see properties on the account like its current requirements or if the account is enabled to make live charges or receive payouts.

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

      The business's annual revenue.

    • estimated_worker_count
      Type: integer | nullFormat: 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 · Company

    Information about the company or business.

    • address

      The customer's address.

    • directors_provided
      Type: boolean

      Whether the company's directors have been provided.

    • directorship_declaration
      Type: object · DeclarationEvidence

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

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

    • ownership_declaration
      Type: object · DeclarationEvidence

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

    • phone
      Type: string | null

      The official business phone for verification and compliance.

    • representative_declaration
      Type: object · DeclarationEvidence

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

    • structure
      Type: string · CompanyStructureenum

      The structure of the company.

      values
      • multi_member_llc
      • private_corporation
      • private_partnership
      • public_corporation
      • public_partnership
    • tax_id_provided
      Type: boolean

      Whether a tax ID has been provided.

    • tax_id_registrar
      Type: string

      The jurisdiction in which the tax ID is registered.

    • vat_id_provided
      Type: boolean

      Whether a VAT ID has been provided.

  • country
    Type: string
    max length:  
    100

    The account's country.

  • default_currency
    Type: string · CurrencyCode

    Three-letter ISO currency code representing the default currency for the account.

  • details_submitted
    Type: boolean

    Whether account details have been submitted. Accounts with Paypercut Dashboard access, which includes Standard accounts, cannot receive payouts before this is true. Accounts where this is false should be directed to an onboarding flow to finish submitting account details.

  • email
    Type: string | null

    The email address of the account holder. This is only to make the account easier to identify to you.

  • 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
  • requirements
    Type: object · AccountRequirements
    • current_deadline
      Type: string | nullFormat: date-time

      Date by which the fields in currently_due must be collected to keep the account enabled. These fields may disable the account sooner if the next threshold is reached before they are collected.

    • currently_due
      Type: array string[] | null

      Fields that need to be collected to keep the account enabled. If not collected by current_deadline, these fields appear in past_due as well, and the account is disabled.

    • disabled_reason
      Type: string | nullenum

      If the account is disabled, this enum describes why.

      values
      • action_required.requested_capabilities
      • listed
      • other
      • platform_paused
      • rejected.fraud
    • errors
      Type: array object[] | null · AccountRequirementsError[]

      Fields that are currently_due and need to be collected again because validation or verification failed.

    • eventually_due
      Type: array string[] | null

      Fields you must collect when all thresholds are reached. As they become required, they appear in currently_due as well, and current_deadline becomes set.

    • past_due
      Type: array string[] | null

      Fields that weren't collected by current_deadline. These fields need to be collected to enable the account.

    • pending_verification
      Type: array string[] | null

      Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to eventually_due, currently_due, or past_due. Fields might appear in eventually_due, currently_due, or past_due and in pending_verification if verification fails but another verification is still pending.

  • tos_acceptance
    Type: object · tos_acceptance_specs

    Details on the account's acceptance of the Paypercut Services Agreement.

    • date
      Type: stringFormat: 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: stringenum

    The type of account to create. May be one of custom, express or standard.

    values
    • standard
    • custom
    • express