AccountUpdateRequest

  • Type: object

    Request to update an Account

    • type
      Type: stringenum

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

      values
      • standard
      • custom
      • express
    • country
      Type: string
      max length:  
      100

      The account's country.

    • default_currency
      Type: string

      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.

    • requirements
      Type: object · AccountRequirements
    • business_profile
      Type: object
    • business_type
      Type: string | nullenum

      The business type.

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

      Information about the company or business.

    • tos_acceptance
    • 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
    • capabilities
      Type: object | null · capabilities_param

      Each key of the dictionary represents a capability, and each capability maps to its settings (for example, whether it has been requested or not). Each capability is inactive until you have provided its specific requirements and Paypercut has verified them. An account might have some of its requested capabilities be active and some be inactive.

    • documents
      Type: object · document_specs

      Documents that may be submitted to satisfy various informational requests.