Account

  • Type: object

    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.

    • created
      Type: stringFormat: date-time
      required

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

    • id
      Type: string
      max length:  
      100
      required

      Unique identifier for the object.

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

      The business type.

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

      Information about the company or business.

    • 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
    • tos_acceptance
      Type: object · tos_acceptance_specs

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

    • type
      Type: stringenum

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

      values
      • standard
      • custom
      • express