--- title: "List Donations" method: GET path: "/v1/donations" tags: ["donations"] --- # List Donations `GET /v1/donations` List donations for your account. ## Query parameters - `limit` integer - `page_token` string - `payment_source_id` string - `deposit_id` string - `created_at.after` string, date-time - `created_at.before` string, date-time - `dafpay_tracking_id` string ## Response `200` The response for Donations.list - object - `results` Donation[] - `id` string, required — The unique identifier for the donation - `external_id` string — A short human-readable identifier for the donation, useful for reconciling against your own systems. This is the same identifier shown on the donation in the Chariot dashboard. - `payment_source_id` string, required — The unique identifier for the payment source used to segregate deposits between various DAFs and platforms. - `amount_gross` integer, required — 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_net` integer, required — 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_fee` integer, required — 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. - `individual_gift_amount` integer — The amount contributed by the individual donor in minor units of the currency. - `currency` string, required — The [ISO 4217 code](https://en.wikipedia.org/wiki/ISO_4217) for the Transaction's currency. - `purpose` string, required — 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". - `note` string, required — 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. - `attribution` DonationAttribution — A subhash containing information about how the donation is attributed. - `primary_donor` Donor — The donor information for the transaction - `full_name` string — The full name of the donor. Maximum length: 255 characters. - `first_name` string — The first name of the donor. Maximum length: 255 characters. - `last_name` string — The last name of the donor. Maximum length: 255 characters. - `email` string — The email address of the donor. Maximum length: 255 characters. - `phone` string — The phone number of the donor. Maximum length: 20 characters. - `address` Address - `city` string, required — City, district, suburb, town, or village. Maximum length: 255 characters. - `country` string, required — Two-letter country code (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) - `line1` string, required — Address line 1 (e.g. street, PO Box, or company name). Maximum length: 255 characters. - `line2` string — Address line 2 (e.g. apartment, suite, unit, or building). Maximum length: 255 characters. - `postal_code` string, required — ZIP or postal code. Maximum length: 40 characters. - `state` string, required — State, county, province, or region - `joint_donor` Donor — The donor information for the transaction - `full_name` string — The full name of the donor. Maximum length: 255 characters. - `first_name` string — The first name of the donor. Maximum length: 255 characters. - `last_name` string — The last name of the donor. Maximum length: 255 characters. - `email` string — The email address of the donor. Maximum length: 255 characters. - `phone` string — The phone number of the donor. Maximum length: 20 characters. - `address` Address - `city` string, required — City, district, suburb, town, or village. Maximum length: 255 characters. - `country` string, required — Two-letter country code (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) - `line1` string, required — Address line 1 (e.g. street, PO Box, or company name). Maximum length: 255 characters. - `line2` string — Address line 2 (e.g. apartment, suite, unit, or building). Maximum length: 255 characters. - `postal_code` string, required — ZIP or postal code. Maximum length: 40 characters. - `state` string, required — State, county, province, or region - `initiation` DonationInitiation — If the donation was initiated through a Chariot Connect instance (DAFpay), this object will contain additional information about the initiation of the donation. - `initiated_at` string, date-time, required — Time when the donation was initiated. Expressed in RFC 3339 format. - `channel` 'INTEGRATED' | 'UNINTEGRATED' — The DAFpay integration channel used to initiate the donation. - `INTEGRATED` - The donation was initiated through an integrated DAFpay instance where the DAF sponsor processes the grant electronically via the DAFpay network. - `UNINTEGRATED` - The donation was initiated through an unintegrated DAFpay flow where the donor completes the grant manually on the DAF sponsor's website (e.g., Luminate Online, standalone embeds). - `web_location_url` string — The URL of the web location where the donation was initiated. - `fundraising_platform_name` string — The name of the fundraising platform that initiated the donation. - `dafpay_form` string — The DAFpay form where the donation was initiated. - `dafpay_tracking_id` string — The tracking ID for the donation as generated by DAFpay. - `dafpay_metadata` object — Additional key value pairs that were passed to DAFpay during the donation initiation. - `frequency` 'ONE_TIME' | 'MONTHLY', required — The frequency of the donation. - `settlement` DonationSettlement — If the payment for the donation was received by Chariot, this object will contain additional information about the settlement of the donation. - `deposit_id` string, required — The unique identifier for the deposit that contains the money for the donation. - `received_at` string, date-time, required — The date and time when the transfer of money for the donation was received by Chariot. Received at indicates when the data for the transfer was received, which is different from the settled_at timestamp. Expressed in RFC 3339 format. - `settled_at` string, date-time — The date and time when the money for the donation was settled by Chariot. Indicates when the funds become available to the nonprofit. Expressed in RFC 3339 format. - `donor_advised_fund_grant` DafGrant — A subhash containing information grant details from a Donor-Advised Fund sponsor. - `organization_name` string, required — The name of the Donor Advised Fund sponsor. - `donor_fund_name` string — The name of the donor's fund at the Donor Advised Fund sponsor. - `program_name` string — The name of the program at the Donor Advised Fund sponsor. - `sponsor_grant_id` string — The identifier for the grant at the Donor Advised Fund sponsor. - `platform` Platform — A subhash containing information about the platform that facilitated the donation. - `name` string — The name of the platform. - `platform_grant_id` string — The identifier for the grant within the platform's system. - `metadata` object — Additional key value pairs that were passed to the platform during the donation initiation. - `acceptance` PlatformAcceptance — A subhash containing information about the acceptance of the grant from the platform. - `accepted` boolean — Whether the grant was accepted from the platform. - `expires_at` string, date-time — The date and time when the acceptance of the grant will expire. - `corporate_match` CorporateMatch — A subhash containing information about the corporate match for the donation. - `match_amount` integer — The amount of the corporate match for the donation in minor units of the donation currency. - `company_name` string — The name of the company that matched the donation. - `program_name` string — The name of the program that matched the donation. - `source` string — The source of the corporate match. - `properties` PropertyAssignment[] — A list of custom properties for the donation. - `property_id` string — The unique identifier for the property. - `value` PropertyValue - `type` 'text' | 'enum' | 'user' | 'boolean' | 'date', required — The data type of a property. - `text_value` string — The text value of the property. - `enum_value_id` string — The unique identifier for the enum value. - `user_value_id` string — The unique identifier for the user. - `boolean_value` boolean — The boolean value of the property. - `date_value` string, date-time — The date value of the property. - `empty` boolean — Whether the property value is empty. Can use this to unset property values when assigning a property. - `artifacts` Artifact[] — 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. - `id` string — The unique identifier for the artifact. - `name` string — The name of the artifact. - `file_id` string — The unique identifier for the file that the artifact is associated with. - `created_at` string, date-time — The date and time when the artifact was created. - `created_at` string, date-time, required — The date and time when the donation was created. - `updated_at` string, date-time — The date and time when the donation was last updated. - `canceled_at` string, date-time, nullable — The date and time when the donation was canceled. A non-null value indicates the donation is tied to a canceled grant initiation and the gift was not received. Expressed in RFC 3339 format. - `payment_status` 'INCOMING_TO_CHARIOT' | 'INCOMING_OUTSIDE_CHARIOT' | 'RECEIVED_IN_CHARIOT' | 'RECEIVED_OUTSIDE_CHARIOT' | 'CANCELED' — The payment status of the donation. Indicates the current state of the payment lifecycle. - `next_page_token` string — 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. ## Other responses - `400` — The request is invalid or contains invalid parameters - `401` — Unauthorized. The request is missing the security (OAuth2 Bearer token) requirements and the server is unable to verify the identify of the caller. - `403` — Access denied - `500` — Internal Server Error --- [API](https://skmtc.net/chariot-giving/apis/specs.md) · [All operations](https://skmtc.net/chariot-giving/apis/specs/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/chariot-giving/specs/revisions/8446023e02fb/schema)