Account

  • Type: object · Account

    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.

    • id
      Type: string
      max length:  
      100
      required

      Unique identifier for the object.

    • created
      Type: string Format: date-time
      required

      Time at which the account was connected. Measured in seconds since the Unix epoch.

    • payments_enabled
      Type: boolean
      required

      Whether this account can currently accept payments.

    • type
      Type: string enum
      required

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

      values
      • standard
      • custom
      • express
    • payouts_enabled
      Type: boolean
      required

      Whether this account can currently receive payouts.

    • country
      Type: string
      max length:  
      100
      required

      The account's country.

    • default_currency
      Type: string · CurrencyCode
      required

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

    • email
      Type: string | null
      required

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

    • details_submitted
      Type: boolean
      required

      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.

    • capabilities
      Type: object · AccountCapabilitiesnullable
      required

      Current status of the capabilities available to this account.

    • livemode
      Type: boolean
      required

      Has the value true if the account exists in live mode or false if it exists in test mode.

    • requirements
      Type: object · AccountRequirements
      required

      Outstanding account and capability requirements. Values in the requirement arrays are field paths, such as details_submitted, company.name, or external_accounts. Provide the referenced account information and inspect associated Persons for any person-specific requirements.

    • business_profile
      Type: object · BusinessProfile
      required
    • business_type
      Type: string | null · BusinessTypeenum
      required

      The business type.

      values
      • company
      • individual
      • non_profit
    • company
      Type: object · Company
      required

      Information about the company or business.

    • tos_acceptance
      Type: object · tos_acceptance_specs
      required

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

    • external_accounts
      Type: object | null · ExternalAccountCollection
      required

      External accounts (bank accounts) currently attached to this account. External accounts are only returned for requests where the expand[] parameter is set to external_accounts and the controller has the permission to access the external account..

    • metadata
      required

      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