Get a Donation | Chariot

curl https://api.givechariot.com/v1/donations/donation_01j8rs605a4gctmbm58d87mvsj \
     -H "Authorization: Bearer <token>"

{
  "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"
}

Get a donation by its unique identifier.

Authentication

AuthorizationBearer

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

Path parameters

idstringRequired

The unique identifier for the donation

Response

The donation was retrieved

idstringRead-only

The unique identifier for the donation

payment_source_idstring

The unique identifier for the payment source used to segregate deposits between various DAFs and platforms.

amount_grosslong

The original amount of the donation as intended by the donor in minor units of the currency. For dollars, for example, this is cents.

amount_netlong

The amount of the donation that the nonprofit will receive after DAF and/or platform processing fees are deducted in minor units of the currency. For dollars, for example, this is cents.

amount_feelong

The amount of the fee that was deducted by the DAF or processing platform from the donation in minor units of the currency. For dollars, for example, this is cents.

currencystring

The ISO 4217 code for the Transaction’s currency.

The [ISO 4217 code](https://en.wikipedia.org/wiki/ISO_4217) for the Transaction's currency.

purposestring

A description of the donor's intent for the donation. This is useful to understand how the donor intended the donation to be used. For example, "Where needed most" or "General Operating Support" or "Specific Campaign".

notestring

An informational note from the donor to the nonprofit about the donation. This may contain a message or other useful information that the donor wants to share with the nonprofit.

created_atstringRead-onlyformat: "date-time"

The date and time when the donation was created.

attributionobject

A subhash containing information about how the donation is attributed.

initiationobject

A subhash containing information about how the donation was initiated by DAFpay.

settlementobject

A subhash containing information about how the donation was settled by Chariot.

donor_advised_fund_grantobject

A subhash containing information about the grant from a Donor-Advised Fund sponsor.

platformobject

A subhash containing information about the platform that facilitated the donation. If this is empty, then the donation was not facilitated by a platform.

corporate_matchobject

A subhash containing information about the corporate match for the donation. If this is empty, then the donation was not matched by a corporate sponsor.

propertieslist of objects

A list of custom properties for the donation.

artifactslist of objects

A list of source artifacts that were used to create the donation. These can include the raw source files (PDFs, CSVs, etc.) that were received from upstream platforms or systems.

updated_atstringRead-onlyformat: "date-time"

The date and time when the donation was last updated.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error