List Donations | Chariot

curl -G https://api.givechariot.com/v1/donations \
     -H "Authorization: Bearer <token>" \
     -d payment_source_id=payment_source_01j8rs605a4gctmbm58d87mvsj \
     -d deposit_id=deposit_01j8rs605a4gctmbm58d87mvsj

{
  "results": [
    {
      "id": "donation_01j8rs605a4gctmbm58d87mvsj",
      "payment_source_id": "payment_source_01kew60ks7w0epkvp2bgqxrt8z",
      "amount_gross": 1,
      "amount_net": 1,
      "amount_fee": 1,
      "currency": "USD",
      "purpose": "Where needed most",
      "note": "Please dedicate in memory of grandma",
      "created_at": "2020-01-31T23:59:59Z",
      "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",
            "line2": "string"
          }
        },
        "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",
            "line2": "string"
          }
        }
      },
      "initiation": {
        "initiated_at": "2020-01-31T23:59:59Z",
        "frequency": "ONE_TIME",
        "web_location_url": "https://www.example.com/donation/1234567890",
        "fundraising_platform_name": "DAF day",
        "dafpay_tracking_id": "L9E182VBGP",
        "dafpay_metadata": {
          "funding_source": "DAF",
          "funding_source_id": "daf_01j8rs605a4gctmbm58d87mvsj",
          "funding_source_name": "DAF day"
        }
      },
      "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",
        "program_name": "string",
        "sponsor_grant_id": "93492947-7894-4663-a944-f2469d0027ca"
      },
      "platform": {
        "name": "PayPal Grant Payments",
        "platform_grant_id": "93492947-7894-4663-a944-f2469d0027ca",
        "metadata": {},
        "acceptance": {
          "accepted": true,
          "expires_at": "2020-01-31T23:59:59Z"
        }
      },
      "corporate_match": {
        "match_amount": 1,
        "company_name": "Google",
        "program_name": "Google Matching Grant Program",
        "source": "Payroll"
      },
      "properties": [
        {
          "property_id": "property_01j8rs605a4gctmbm58d87mvsj",
          "value": {
            "type": "text",
            "text_value": "string",
            "enum_value_id": "string",
            "user_value_id": "string",
            "boolean_value": true,
            "date_value": "2024-01-15T09:30:00Z",
            "empty": true
          }
        }
      ],
      "artifacts": [
        {
          "id": "artifact_01j8rs605a4gctmbm58d87mvsj",
          "name": "donation_receipt.pdf",
          "file_id": "file_01j8rs605a4gctmbm58d87mvsj",
          "created_at": "2020-01-31T23:59:59Z"
        }
      ],
      "updated_at": "2020-01-31T23:59:59Z"
    }
  ],
  "next_page_token": "string"
}

List donations for your account.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

limitintegerOptional

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

page_tokenstringOptional

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

payment_source_idstringOptional

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

deposit_idstringOptional

The unique identifier for the deposit to filter donations by.

created_at.afterstringOptionalformat: "date-time"

Return donations created after the given date and time.

created_at.beforestringOptionalformat: "date-time"

Return donations created before the given date and time.

Response

The response for Donations.list

resultslist of objects or null

next_page_tokenstring or null

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.

Authentication

Query parameters

Response

Errors