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.

  • type
    Type: "standard" or "custom" or "express"enum

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

  • country
    Type: string
    max length:  
    100

    The account's country.

  • default_currency
    Type: CurrencyCode

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

  • email
    Type: string | null

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

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

  • capabilities
    Type: AccountCapabilitiesnullable

    Current status of the capabilities available to this account.

    Properties: 3
  • livemode
    Type: boolean

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

  • requirements
    Type: AccountRequirements

    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.

    Properties: 7
  • business_profile
    Type: BusinessProfile
    Properties: 11
  • business_type
    Type: BusinessTypeenum

    The business type.

    values
    companyindividualnon_profit
  • company
    Type: Company

    Information about the company or business.

    Properties: 17
  • tos_acceptance
    Type: tos_acceptance_specs

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

    Properties: 4
  • 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
      additionalPropertyType: string