donations

List Donations

List donations for your account.

get/v1/donations

Query parameters

limitinteger

Limit the size of the list that is returned. The default (and maximum) is 100 objects.

page_tokenstring

The cursor to use for pagination. If not set, the first page of results will be returned.

payment_source_idstring

The unique identifier for the payment sources to filter donations by. Comma separated list of payment source IDs.

deposit_idstring

The unique identifier for the deposit to filter donations by.

created_at.afterstring date-time

Return donations created after the given date and time.

created_at.beforestring date-time

Return donations created before the given date and time.

dafpay_tracking_idstring

The DAFpay tracking identifier to filter donations by. Use this to reconcile a donation against the DAFpay grant that started it.

Response

The response for Donations.list

next_page_tokenstring

A cursor token to use to retrieve the next page of results by making another API call to the same endpoint with the same parameters (only changing the pageToken). If specified, then more results exist on the server that were not returned, otherwise no more results exist on the server.

Example response

{
  "results": [
    {
      "id": "donation_01j8rs605a4gctmbm58d87mvsj",
      "external_id": "29247869",
      "payment_source_id": "payment_source_01kew60ks7w0epkvp2bgqxrt8z",
      "currency": "USD",
      "purpose": "Where needed most",
      "note": "Please dedicate in memory of grandma",
      "attribution": {
        "primary_donor": {
          "full_name": "John Doe",
          "first_name": "John",
          "last_name": "Doe",
          "email": "bob@me.com",
          "phone": "415-555-1212",
          "address": {
            "city": "New York",
            "country": "US",
            "line1": "123 Main St.",
            "postal_code": "12345",
            "state": "NY"
          }
        },
        "joint_donor": {
          "full_name": "John Doe",
          "first_name": "John",
          "last_name": "Doe",
          "email": "bob@me.com",
          "phone": "415-555-1212",
          "address": {
            "city": "New York",
            "country": "US",
            "line1": "123 Main St.",
            "postal_code": "12345",
            "state": "NY"
          }
        }
      },
      "initiation": {
        "initiated_at": "2020-01-31T23:59:59Z",
        "channel": "INTEGRATED",
        "web_location_url": "https://www.example.com/donation/1234567890",
        "fundraising_platform_name": "Classy",
        "dafpay_form": "DAF day",
        "dafpay_tracking_id": "L9E182VBGP",
        "dafpay_metadata": {
          "funding_source": "DAF",
          "funding_source_id": "daf_01j8rs605a4gctmbm58d87mvsj",
          "funding_source_name": "DAF day"
        },
        "frequency": "ONE_TIME"
      },
      "settlement": {
        "deposit_id": "deposit_01kewb5vgsryzaajza5ynr06kz",
        "received_at": "2020-01-31T23:59:59Z",
        "settled_at": "2020-01-31T23:59:59Z"
      },
      "donor_advised_fund_grant": {
        "organization_name": "Daffy Charitable Fund",
        "donor_fund_name": "The Smith Family Fund",
        "sponsor_grant_id": "93492947-7894-4663-a944-f2469d0027ca"
      },
      "platform": {
        "name": "PayPal Grant Payments",
        "platform_grant_id": "93492947-7894-4663-a944-f2469d0027ca",
        "acceptance": {
          "accepted": true,
          "expires_at": "2020-01-31T23:59:59Z"
        }
      },
      "corporate_match": {
        "company_name": "Google",
        "program_name": "Google Matching Grant Program",
        "source": "Payroll"
      },
      "properties": [
        {
          "property_id": "prop_01j8rs605a4gctmbm58d87mvsj",
          "value": {
            "type": "text"
          }
        }
      ],
      "artifacts": [
        {
          "id": "artifact_01j8rs605a4gctmbm58d87mvsj",
          "name": "donation_receipt.pdf",
          "file_id": "file_01j8rs605a4gctmbm58d87mvsj",
          "created_at": "2020-01-31T23:59:59Z"
        }
      ],
      "created_at": "2020-01-31T23:59:59Z",
      "updated_at": "2020-01-31T23:59:59Z",
      "canceled_at": "2020-01-31T23:59:59Z",
      "payment_status": "INCOMING_TO_CHARIOT"
    }
  ]
}

Changes

Changed in 10 of the 41 revisions of this API.201454

    • deleted the query request parameter lockbox_id

      request-parameter-removed

    • deleted the query request parameter mail_item_id

      request-parameter-removed

    • removed the optional property results/items/lockbox_id from the response with the 200 status

      response-optional-property-removed

    • removed the optional property results/items/mail_item_id from the response with the 200 status

      response-optional-property-removed

    • added the new optional query request parameter dafpay_tracking_id

      new-optional-request-parameter

    • added the new optional query request parameter lockbox_id

      new-optional-request-parameter

    • added the new optional query request parameter mail_item_id

      new-optional-request-parameter

    • added the optional property results/items/external_id to the response with the 200 status

      response-optional-property-added

    • added the optional property results/items/lockbox_id to the response with the 200 status

      response-optional-property-added

    • added the optional property results/items/mail_item_id to the response with the 200 status

      response-optional-property-added

  • b87f7738d336820See the full diff
    • removed the required property code from the response with the 400 status

      response-required-property-removed

    • removed the required property code from the response with the 401 status

      response-required-property-removed

    • removed the required property code from the response with the 403 status

      response-required-property-removed

    • removed the required property code from the response with the 500 status

      response-required-property-removed

    • removed the required property message from the response with the 400 status

      response-required-property-removed

    • removed the required property message from the response with the 401 status

      response-required-property-removed

    • removed the required property message from the response with the 403 status

      response-required-property-removed

    • removed the required property message from the response with the 500 status

      response-required-property-removed

    • media type application/json was changed to a more specific media type application/problem+json for the response status 400

      response-media-type-name-specialized

    • media type application/json was changed to a more specific media type application/problem+json for the response status 401

      response-media-type-name-specialized

    • media type application/json was changed to a more specific media type application/problem+json for the response status 403

      response-media-type-name-specialized

    • media type application/json was changed to a more specific media type application/problem+json for the response status 500

      response-media-type-name-specialized

    • added the required property detail to the response with the 400 status

      response-required-property-added

    • added the required property detail to the response with the 401 status

      response-required-property-added

    • added the required property detail to the response with the 403 status

      response-required-property-added

    • added the required property detail to the response with the 500 status

      response-required-property-added

    • added the required property status to the response with the 400 status

      response-required-property-added

    • added the required property status to the response with the 401 status

      response-required-property-added

    • added the required property status to the response with the 403 status

      response-required-property-added

    • added the required property status to the response with the 500 status

      response-required-property-added

    • added the required property title to the response with the 400 status

      response-required-property-added

    • added the required property title to the response with the 401 status

      response-required-property-added

    • added the required property title to the response with the 403 status

      response-required-property-added

    • added the required property title to the response with the 500 status

      response-required-property-added

    • added the required property type to the response with the 400 status

      response-required-property-added

    • added the required property type to the response with the 401 status

      response-required-property-added

    • added the required property type to the response with the 403 status

      response-required-property-added

    • added the required property type to the response with the 500 status

      response-required-property-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • removed the optional property details from the response with the 400 status

      response-optional-property-removed

    • removed the optional property details from the response with the 401 status

      response-optional-property-removed

    • removed the optional property details from the response with the 403 status

      response-optional-property-removed

    • removed the optional property details from the response with the 500 status

      response-optional-property-removed

    • added the optional property details/items/debug to the response with the 400 status

      response-optional-property-added

    • added the optional property details/items/debug to the response with the 401 status

      response-optional-property-added

    • added the optional property details/items/debug to the response with the 403 status

      response-optional-property-added

    • added the optional property details/items/debug to the response with the 500 status

      response-optional-property-added

    • added the optional property details/items/type to the response with the 400 status

      response-optional-property-added

    • added the optional property details/items/type to the response with the 401 status

      response-optional-property-added

    • added the optional property details/items/type to the response with the 403 status

      response-optional-property-added

    • added the optional property details/items/type to the response with the 500 status

      response-optional-property-added

    • added the optional property details/items/value to the response with the 400 status

      response-optional-property-added

    • added the optional property details/items/value to the response with the 401 status

      response-optional-property-added

    • added the optional property details/items/value to the response with the 403 status

      response-optional-property-added

    • added the optional property details/items/value to the response with the 500 status

      response-optional-property-added

  • 90671617b825124See the full diff
    • the code response's property type/format changed from number/ to string/ for status 400

      response-property-type-changed

    • the code response's property type/format changed from number/ to string/ for status 401

      response-property-type-changed

    • the code response's property type/format changed from number/ to string/ for status 403

      response-property-type-changed

    • the code response's property type/format changed from number/ to string/ for status 500

      response-property-type-changed

    • removed the required property error from the response with the 400 status

      response-required-property-removed

    • removed the required property error from the response with the 401 status

      response-required-property-removed

    • removed the required property error from the response with the 403 status

      response-required-property-removed

    • removed the required property error from the response with the 500 status

      response-required-property-removed

    • removed the required property timestamp from the response with the 400 status

      response-required-property-removed

    • removed the required property timestamp from the response with the 401 status

      response-required-property-removed

    • removed the required property timestamp from the response with the 403 status

      response-required-property-removed

    • removed the required property timestamp from the response with the 500 status

      response-required-property-removed

    • added the optional property details to the response with the 400 status

      response-optional-property-added

    • added the optional property details to the response with the 401 status

      response-optional-property-added

    • added the optional property details to the response with the 403 status

      response-optional-property-added

    • added the optional property details to the response with the 500 status

      response-optional-property-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • removed the UNSPECIFIED enum value from the results/items/payment_status response property for the response status 200

      response-property-enum-value-removed

  • 60a0df78dd7a66See the full diff
    • added the new CANCELED enum value to the results/items/payment_status response property for the response status 200

      response-property-enum-value-added

    • added the new INCOMING_OUTSIDE_CHARIOT enum value to the results/items/payment_status response property for the response status 200

      response-property-enum-value-added

    • added the new INCOMING_TO_CHARIOT enum value to the results/items/payment_status response property for the response status 200

      response-property-enum-value-added

    • added the new RECEIVED_IN_CHARIOT enum value to the results/items/payment_status response property for the response status 200

      response-property-enum-value-added

    • added the new RECEIVED_OUTSIDE_CHARIOT enum value to the results/items/payment_status response property for the response status 200

      response-property-enum-value-added

    • added the new UNSPECIFIED enum value to the results/items/payment_status response property for the response status 200

      response-property-enum-value-added

    • removed the PAYMENT_STATUS_CANCELED enum value from the results/items/payment_status response property for the response status 200

      response-property-enum-value-removed

    • removed the PAYMENT_STATUS_INCOMING_OUTSIDE_CHARIOT enum value from the results/items/payment_status response property for the response status 200

      response-property-enum-value-removed

    • removed the PAYMENT_STATUS_INCOMING_TO_CHARIOT enum value from the results/items/payment_status response property for the response status 200

      response-property-enum-value-removed

    • removed the PAYMENT_STATUS_RECEIVED_IN_CHARIOT enum value from the results/items/payment_status response property for the response status 200

      response-property-enum-value-removed

    • removed the PAYMENT_STATUS_RECEIVED_OUTSIDE_CHARIOT enum value from the results/items/payment_status response property for the response status 200

      response-property-enum-value-removed

    • removed the PAYMENT_STATUS_UNSPECIFIED enum value from the results/items/payment_status response property for the response status 200

      response-property-enum-value-removed

    • added the optional property results/items/payment_status to the response with the 200 status

      response-optional-property-added

    • added the optional property results/items/canceled_at to the response with the 200 status

      response-optional-property-added

    • added the optional property results/items/individual_gift_amount to the response with the 200 status

      response-optional-property-added

    • added the optional property results/items/initiation/allOf[DonationInitiation]/channel to the response with the 200 status

      response-optional-property-added

    • added the optional property results/items/initiation/allOf[DonationInitiation]/dafpay_form to the response with the 200 status

      response-optional-property-added