DonationResponse

  • asset
    Type: object

    Asset (Model)

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

    • currency
      Type: object

      AssetCurrency (Interface)

    • description
      Type: string
    • equity
      Type: object

      AssetEquity (Interface)

    • factor
      Type: number
    • fixed_income
      Type: object

      AssetFixedIncome (Interface)

    • fmv
      Type: number
    • fmv_as_of
      Type: stringFormat: date-time

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

    • icon_url
      Type: string
    • investment_rate_yearly
      Type: number
    • isin
      Type: string
    • issuing_region_code
      Type: string
    • logo_url
      Type: string
    • mutual_fund
      Type: object

      AssetMutualFund (Interface)

    • name
      Type: string
    • option
      Type: object

      AssetOption (Interface)

    • originating_region_code
      Type: string
    • symbol
      Type: string
    • type
      Type: stringenum
      values
      • type_unspecified
      • equity
      • option
      • currency
      • digital
      • fdic_synthetic
      • fixed_income
      • mutual_fund
      • alt_investment
    • 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

    • usable
      Type: boolean
  • campaign
    Type: object

    CampaignResponse (Interface)

    • accent_color
      Type: string
    • accepts_cash_donations
      Type: boolean
    • accepts_crypto_donations
      Type: boolean
    • accepts_daf_donations
      Type: boolean
    • accepts_endowment_donations
      Type: boolean
    • accepts_stock_donations
      Type: boolean
    • acknowledgement_message
      Type: string
    • content_header
      Type: string
    • cover_image
      Type: object

      Document (Model)

    • cover_image_asset_id
      Type: number | null
    • created_at
      Type: stringFormat: date

      full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21

    • deleted_at
      Type: string | nullFormat: date

      full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21

    • donation_count
      Type: number | null
    • goal
      Type: number | null
    • id
      Type: number
    • legacy_cash_url
      Type: string
    • logo
      Type: object

      Document (Model)

    • logo_asset_id
      Type: number | null
    • name
      Type: string
    • page_content
      Type: string
    • page_title
      Type: string
    • revenue
      Type: number | null
    • slug
      Type: string
    • status
      Type: stringenum
      values
      • active
      • archived
      • draft
    • suggested_amount_1
      Type: number
    • suggested_amount_2
      Type: number
    • suggested_amount_3
      Type: number
    • suggested_amount_4
      Type: number
    • updated_at
      Type: stringFormat: date

      full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21

    • white_listed_domains
      Type: string
  • cancelation_reason
    Type: string | nullenum
    values
    • duplicate
    • donor_cancel
    • other
  • created_at
    Type: string
  • designation
    Type: object

    CampaignDesignationResponse (Interface)

    • 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

    • id
      Type: string
    • name
      Type: string
    • priority
      Type: number
    • 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

  • donor_address_line_1
    Type: string | null
  • donor_address_line_2
    Type: string | null
  • donor_city
    Type: string | null
  • donor_country
    Type: string | null
  • donor_email
    Type: string
  • donor_first_name
    Type: string
  • donor_last_name
    Type: string
  • donor_postal_code
    Type: string | null
  • donor_province
    Type: string | null
  • id
    Type: string
  • identifier
    Type: string
  • memo
    Type: string | null
  • payment
    Type: object

    DonationPayment (Interface)

    • amount
      Type: number | null
    • bank_account
      Type: object | null
    • brokerage
      Type: object | null
    • card
      Type: object | null
    • cashapp
      Type: object | null
    • fees
      Type: array (DonationFee | null)[] · DonationFee[]

      DonationFee (Interface)

    • net
      Type: number | null
    • type
      Type: stringenum
      values
      • us_bank_account
      • card
      • cashapp
      • brokerage
  • payout
    Type: object

    WithdrawalResponse (Interface)

    • 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

    • 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

    • description
      Type: string
    • 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

    • from
      Type: object

      AccountResponse (Interface)

    • id
      Type: string
    • initiated_by_user
      Type: object

      UserResponse (Interface)

    • is_full_disbursement
      Type: boolean
    • status
      Type: stringenum
      values
      • Pending
      • Requested
      • Suspended
      • FundsPosted
      • Postponed
    • to
      Type: object

      ExternalAccountResponse (Interface)

    • transfers
      Type: array WithdrawalTransferResponse[] · WithdrawalTransferResponse[]

      WithdrawalTransferResponse (Interface)

    • type
      Type: stringenum
      values
      • ACH
      • WIRE
      • CHECK
    • 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

  • quantity
    Type: number
  • recognition
    Type: stringenum
    values
    • public
    • private
    • anonymous
  • source
    Type: string | null
  • status
    Type: stringenum
    values
    • pledged
    • pending
    • processing
    • complete
    • failed
  • stock_received_date
    Type: string | null
  • tax_deductible_amount
    Type: number | null
  • trade
    Type: object

    Trade (Model)

    • asset
      Type: object

      Asset (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

    • 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

    • fill_price
      Type: number
    • fill_quantity
      Type: number
    • id
      Type: string
    • ideal_execution_total
      Type: number
    • liquidity_fee
      Type: number
    • misc_fee
      Type: number
    • nasd_fee
      Type: number
    • order
      Type: object

      Order (Model)

    • orf_fee
      Type: number
    • postedge_fee
      Type: number
    • quantity
      Type: number
    • sec_fee
      Type: number
    • settled_at
      Type: stringFormat: date-time

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

    • side
      Type: stringenum
      values
      • buy
      • sell
    • status
      Type: stringenum
      values
      • pending_new
      • new
      • partially_filled
      • filled
      • rejected
    • 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

  • type
    Type: stringenum
    values
    • currency
    • stock
    • crypto
    • daf
  • updated_at
    Type: string