Account

Account snapshot for account.created and account.updated events.

  • type
    Type: stringenum

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

    values
    • standard

      Account managed through the Merchant Dashboard.

    • custom

      Account managed by the platform integration.

    • express

      Account using the Express onboarding flow.

  • 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
  • business_type
    Type: BusinessTypeenum

    The business type.

    values
    companyindividualnon_profit
  • id
    Type: string
    required

    Account ID.

  • created_at
    Type: stringFormat: date-time

    Time the Account was created.

  • updated_at
    Type: stringFormat: date-time

    Time the Account was last updated.

  • object
    enum
    const:  
    account
    required

    Identifies the resource carried by this event.

  • default_locale
    Type: string | null

    Default locale for the account.

  • revision
    Type: integer

    Revision of the account details.

  • details_submitted_at
    Type: string | nullFormat: date-time

    Time the account details were submitted.

  • payments_enabled
    Type: boolean

    Whether the account can accept payments.

  • payouts_enabled
    Type: boolean

    Whether the account can receive payouts.

  • livemode
    Type: boolean

    Whether the resource belongs to live mode or test mode.

  • requirements
    Type: Requirements

    Information or verification needed for this resource at the time of the event.

    Properties: 7
  • company
    Type: Company

    Company information recorded on the account.

    Properties: 17
  • business_profile
    Type: Business profile

    Customer-facing business information recorded on the account.

    Properties: 11
  • tos_acceptance
    Type: Terms acceptance

    The account's recorded acceptance of the Paypercut Services Agreement.

    Properties: 4
  • connect_role
    Type: string | null

    Role of the account in a Connect integration.

  • connected_platform_account_id
    Type: string | null

    Platform account associated with this connected account.

  • metadata

    Metadata attached to the resource.

    Metadata attached to the resource.

    • propertyName
      additionalPropertyType: string