Withdrawal

Withdrawal (Model)

  • amount
    Type: number
  • created_at
    Type: stringFormat: date-time

    the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

  • from
    Type: object · Account

    Account (Model)

    • account_number
      Type: string
    • account_type
      Type: stringenum
      values
      • reserve
      • growth
      • endowment
      • donations_only
    • accounts
      Type: array object[] · ExternalAccount[]

      ExternalAccount (Model)

    • async_close_this
      Type: object · Account

      Account (Model)

    • aum_fee
      Type: number
    • balance
      Type: number
    • cash_balance
      Type: number
    • consent_event
      Type: object · ConsentEvent

      ConsentEvent (Model)

    • created_at
      Type: stringFormat: date-time

      the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

    • deposits
      Type: array object[] · Deposit[]

      Deposit (Model)

    • disbursement_annual_percentage
      Type: number
    • disbursement_frequency
      Type: string
    • documents
      Type: array object[] · Document[]

      Document (Model)

    • equities_balance
      Type: number
    • id
      Type: string
    • initial_deposit_amount
      Type: number
    • ips_document
      Type: object · Document

      Document (Model)

    • name
      Type: string
    • orders
      Type: array object[] · Order[]

      Order (Model)

    • organization
      Type: object · Organization

      Organization (Model)

    • portfolio
      Type: object · Portfolio

      Portfolio (Model)

    • positions
      Type: array object[] · PositionResponse[]

      PositionResponse (Interface)

    • privileged_donor_users
      Type: array object[] · User[]

      User (Model)

    • status
      Type: stringenum
      values
      • draft
      • ready_for_ig_review
      • pending_apex
      • active
      • pending_closure
      • closed
    • transactions
      Type: array object[] · Transaction[]

      Transaction (Model)

    • transfers
      Type: array object[] · AccountTransfer[]

      AccountTransfer (Model)

    • updated_at
      Type: stringFormat: date-time

      the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

    • withdrawals
      Type: array object[] · Withdrawal[]

      Withdrawal (Model)

  • id
    Type: string
  • initiated_by_user
    Type: object · User

    User (Model)

    • address_line_1
      Type: string
    • address_line_2
      Type: string
    • affiliate_approval_document
      Type: object · Document

      Document (Model)

    • affiliated_member_firms
      Type: array string[]
    • affiliated_publicly_traded_companies
      Type: array string[]
    • city
      Type: string
    • consent_events
      Type: array object[] · ConsentEvent[]

      ConsentEvent (Model)

    • country
      Type: string · CountryCodeenum nullable

      ISO 3166-1 alpha-2 country code

      values
      • ad
      • ae
      • af
      • ag
      • ai
    • created_at
      Type: stringFormat: date-time

      the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

    • date_of_birth
      Type: stringFormat: date-time

      the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

    • email
      Type: stringFormat: email
    • email_verified_at
      Type: stringFormat: date-time

      the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

    • first_name
      Type: string
    • full_name
      Type: string
    • id
      Type: string
    • identification_type
      Type: stringenum
      values
      • national_identity_card
      • driving_licence
      • passport
      • voter_id
      • work_permit
      • unknown
    • identification_verified
      Type: boolean
    • identity_document_back
      Type: object · Document

      Document (Model)

    • identity_document_front
      Type: object · Document

      Document (Model)

    • ig_role
      Type: stringenum
      values
      • admin
      • viewer
      • null
    • investment_experience
      Type: stringenum
      values
      • none
      • limited
      • good
      • extensive
    • is_super_admin
      Type: boolean
    • last_name
      Type: string
    • legal_first_name
      Type: string
    • legal_full_name
      Type: string
    • legal_last_name
      Type: string
    • legal_middle_name
      Type: string
    • nationalities
      Type: array string[] · CountryCode[]enum
      values
      • ad
      • ae
      • af
      • ag
      • ai
    • negative_news
      Type: string
    • notification_preferences
      Type: array object[] · UserNotificationPreference[]

      UserNotificationPreference (Model)

    • organizations
      Type: array object[] · Organization[]

      Organization (Model)

    • phone
      Type: string
    • pii_confirmed_at
      Type: stringFormat: date-time

      the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

    • political_exposure
      Type: object · PoliticalExposure

      PoliticalExposure (Interface)

    • postal_code
      Type: string
    • privileged_donor_accounts
      Type: array object[] · Account[]

      Account (Model)

    • province
      Type: string
    • residency_status
      Type: stringenum
      values
      • us_permanent_resident
      • us_temporary_resident
      • us_non_resident
    • tax_id
      Type: string
    • tax_id_type
      Type: stringenum
      values
      • itin
      • ssn
    • updated_at
      Type: stringFormat: date-time

      the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

  • is_full_disbursement
    Type: boolean
  • memo
    Type: string
  • status
    Type: stringenum
    values
    • pending
    • in_progress
    • complete
    • canceled
    • error
  • to
    Type: object · ExternalAccount

    ExternalAccount (Model)

    • added_by_user
      Type: object · User

      User (Model)

    • bank_brand_color
      Type: string
    • bank_name
      Type: string
    • beneficiary_is_third_party
      Type: boolean
    • created_at
      Type: stringFormat: date-time

      the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

    • deleted_at
      Type: stringFormat: date-time

      the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

    • id
      Type: string
    • logo
      Type: object · Document

      Document (Model)

    • logo_url
      Type: string
    • mask
      Type: string
    • name
      Type: string
    • organization
      Type: object · Organization

      Organization (Model)

    • status
      Type: stringenum
      values
      • pending_automatic_verification
      • pending_manual_verification
      • approved
      • expired
      • failed
      • re_auth_required
    • type
      Type: stringenum
      values
      • primary
      • wire
    • updated_at
      Type: stringFormat: date-time

      the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

  • transfers
    Type: array object[] · WithdrawalTransfer[]

    WithdrawalTransfer (Model)

    • amount
      Type: number
    • apex_name
      Type: string
    • created_at
      Type: stringFormat: date-time

      the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

    • executed_at
      Type: stringFormat: date-time

      the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

    • external_id
      Type: string
    • id
      Type: string
    • reference_number
      Type: string
    • return_codes
      Type: array string[]
    • status
      Type: stringenum
      values
      • processing
      • pending_review
      • posted
      • completed
      • rejected
      • canceled
      • returned
      • postponed
    • updated_at
      Type: stringFormat: date-time

      the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

    • withdrawal
      Type: object · Withdrawal

      Withdrawal (Model)

  • type
    Type: stringenum
    values
    • ach
    • wire
  • updated_at
    Type: stringFormat: date-time

    the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z