DonationCreatedResponse

A donation as returned by the public create endpoints, merged with checkout meta. Narrower than DonationResponse: the handler serializes a row it just created rather than one it read back, so asset and payment are never present, designation is the only relation returned, and no foreign key fields are serialized. Fields below are always present; nullable ones are returned as null rather than omitted.

  • created_at
    Type: stringFormat: date-time
    required

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

  • donor_email
    Type: string
    required
  • donor_first_name
    Type: string
    required
  • donor_last_name
    Type: string
    required
  • id
    Type: string
    required

    Donation uuid.

  • identifier
    Type: string
    required

    Currency code, ticker symbol, or coin symbol depending on type.

  • is_recurring
    Type: boolean
    required

    True when the donation belongs to a subscription.

  • meta
    Type:
    required

    Server-provided fields to finish checkout on a public giving page. Varies by donation type (e.g. Stripe for currency, wallet address for crypto, DTC instructions for stock).

    Properties: 5
  • quantity
    Type: number
    required

    Amount for currency donations, share or coin count otherwise.

  • recognition
    Type: "public" or "private" or "anonymous"enum
    required
  • status
    Type: stringenum
    required
    values
    pledgedpendingprocessingcompletefailedcanceled
  • type
    Type: stringenum
    required
    values
    currencystockcryptodaf
  • updated_at
    Type: stringFormat: date-time
    required

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

  • cancelation_reason
    Type: "duplicate" or "donor_cancel" or "other"enum
  • designation
    Type: nullable

    Null when the donor picked no designation, or the campaign has none.

    Properties: 5
  • donor_address_line_1
    Type: string | null
  • donor_address_line_2
    Type: string | null
  • donor_city
    Type: string | null
  • donor_confirmed_at
    Type: string | nullFormat: date-time

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

  • donor_country
    Type: string | null

    Two-letter ISO country code.

  • donor_postal_code
    Type: string | null
  • donor_province
    Type: string | null
  • donor_reported_transfer_date
    Type: string | nullFormat: date

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

  • memo
    Type: string | null
  • source
    Type: string | null

    Stripe PaymentIntent id, crypto wallet address, or the donor's brokerage for stock.

  • tax_deductible_amount
    Type: number | null

    Set on create for currency donations only; null for stock, crypto and DAF until valued.