List Donations
List donations for your account.
Query parameters
Limit the size of the list that is returned. The default (and maximum) is 100 objects.
The cursor to use for pagination. If not set, the first page of results will be returned.
The unique identifier for the payment sources to filter donations by. Comma separated list of payment source IDs.
The unique identifier for the deposit to filter donations by.
Return donations created after the given date and time.
Return donations created before the given date and time.
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
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
queryrequest parameterlockbox_idrequest-parameter-removed
- ●
deleted the
queryrequest parametermail_item_idrequest-parameter-removed
- ●
removed the optional property
results/items/lockbox_idfrom the response with the200statusresponse-optional-property-removed
- ●
removed the optional property
results/items/mail_item_idfrom the response with the200statusresponse-optional-property-removed
- ●
- ○
added the new optional
queryrequest parameterdafpay_tracking_idnew-optional-request-parameter
- ○
added the new optional
queryrequest parameterlockbox_idnew-optional-request-parameter
- ○
added the new optional
queryrequest parametermail_item_idnew-optional-request-parameter
- ○
added the optional property
results/items/external_idto the response with the200statusresponse-optional-property-added
- ○
added the optional property
results/items/lockbox_idto the response with the200statusresponse-optional-property-added
- ○
added the optional property
results/items/mail_item_idto the response with the200statusresponse-optional-property-added
- ○
- ▲
removed the required property
codefrom the response with the400statusresponse-required-property-removed
- ▲
removed the required property
codefrom the response with the401statusresponse-required-property-removed
- ▲
removed the required property
codefrom the response with the403statusresponse-required-property-removed
- ▲
removed the required property
codefrom the response with the500statusresponse-required-property-removed
- ▲
removed the required property
messagefrom the response with the400statusresponse-required-property-removed
- ▲
removed the required property
messagefrom the response with the401statusresponse-required-property-removed
- ▲
removed the required property
messagefrom the response with the403statusresponse-required-property-removed
- ▲
removed the required property
messagefrom the response with the500statusresponse-required-property-removed
- ○
media type
application/jsonwas changed to a more specific media typeapplication/problem+jsonfor the response status400response-media-type-name-specialized
- ○
media type
application/jsonwas changed to a more specific media typeapplication/problem+jsonfor the response status401response-media-type-name-specialized
- ○
media type
application/jsonwas changed to a more specific media typeapplication/problem+jsonfor the response status403response-media-type-name-specialized
- ○
media type
application/jsonwas changed to a more specific media typeapplication/problem+jsonfor the response status500response-media-type-name-specialized
- ○
added the required property
detailto the response with the400statusresponse-required-property-added
- ○
added the required property
detailto the response with the401statusresponse-required-property-added
- ○
added the required property
detailto the response with the403statusresponse-required-property-added
- ○
added the required property
detailto the response with the500statusresponse-required-property-added
- ○
added the required property
statusto the response with the400statusresponse-required-property-added
- ○
added the required property
statusto the response with the401statusresponse-required-property-added
- ○
added the required property
statusto the response with the403statusresponse-required-property-added
- ○
added the required property
statusto the response with the500statusresponse-required-property-added
- ○
added the required property
titleto the response with the400statusresponse-required-property-added
- ○
added the required property
titleto the response with the401statusresponse-required-property-added
- ○
added the required property
titleto the response with the403statusresponse-required-property-added
- ○
added the required property
titleto the response with the500statusresponse-required-property-added
- ○
added the required property
typeto the response with the400statusresponse-required-property-added
- ○
added the required property
typeto the response with the401statusresponse-required-property-added
- ○
added the required property
typeto the response with the403statusresponse-required-property-added
- ○
added the required property
typeto the response with the500statusresponse-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
detailsfrom the response with the400statusresponse-optional-property-removed
- ●
removed the optional property
detailsfrom the response with the401statusresponse-optional-property-removed
- ●
removed the optional property
detailsfrom the response with the403statusresponse-optional-property-removed
- ●
removed the optional property
detailsfrom the response with the500statusresponse-optional-property-removed
- ●
- ○
added the optional property
details/items/debugto the response with the400statusresponse-optional-property-added
- ○
added the optional property
details/items/debugto the response with the401statusresponse-optional-property-added
- ○
added the optional property
details/items/debugto the response with the403statusresponse-optional-property-added
- ○
added the optional property
details/items/debugto the response with the500statusresponse-optional-property-added
- ○
added the optional property
details/items/typeto the response with the400statusresponse-optional-property-added
- ○
added the optional property
details/items/typeto the response with the401statusresponse-optional-property-added
- ○
added the optional property
details/items/typeto the response with the403statusresponse-optional-property-added
- ○
added the optional property
details/items/typeto the response with the500statusresponse-optional-property-added
- ○
added the optional property
details/items/valueto the response with the400statusresponse-optional-property-added
- ○
added the optional property
details/items/valueto the response with the401statusresponse-optional-property-added
- ○
added the optional property
details/items/valueto the response with the403statusresponse-optional-property-added
- ○
added the optional property
details/items/valueto the response with the500statusresponse-optional-property-added
- ○
- ▲
the
coderesponse's property type/format changed fromnumber/tostring/for status400response-property-type-changed
- ▲
the
coderesponse's property type/format changed fromnumber/tostring/for status401response-property-type-changed
- ▲
the
coderesponse's property type/format changed fromnumber/tostring/for status403response-property-type-changed
- ▲
the
coderesponse's property type/format changed fromnumber/tostring/for status500response-property-type-changed
- ▲
removed the required property
errorfrom the response with the400statusresponse-required-property-removed
- ▲
removed the required property
errorfrom the response with the401statusresponse-required-property-removed
- ▲
removed the required property
errorfrom the response with the403statusresponse-required-property-removed
- ▲
removed the required property
errorfrom the response with the500statusresponse-required-property-removed
- ▲
removed the required property
timestampfrom the response with the400statusresponse-required-property-removed
- ▲
removed the required property
timestampfrom the response with the401statusresponse-required-property-removed
- ▲
removed the required property
timestampfrom the response with the403statusresponse-required-property-removed
- ▲
removed the required property
timestampfrom the response with the500statusresponse-required-property-removed
- ○
added the optional property
detailsto the response with the400statusresponse-optional-property-added
- ○
added the optional property
detailsto the response with the401statusresponse-optional-property-added
- ○
added the optional property
detailsto the response with the403statusresponse-optional-property-added
- ○
added the optional property
detailsto the response with the500statusresponse-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
UNSPECIFIEDenum value from theresults/items/payment_statusresponse property for the response status200response-property-enum-value-removed
- ○
- ●
added the new
CANCELEDenum value to theresults/items/payment_statusresponse property for the response status200response-property-enum-value-added
- ●
added the new
INCOMING_OUTSIDE_CHARIOTenum value to theresults/items/payment_statusresponse property for the response status200response-property-enum-value-added
- ●
added the new
INCOMING_TO_CHARIOTenum value to theresults/items/payment_statusresponse property for the response status200response-property-enum-value-added
- ●
added the new
RECEIVED_IN_CHARIOTenum value to theresults/items/payment_statusresponse property for the response status200response-property-enum-value-added
- ●
added the new
RECEIVED_OUTSIDE_CHARIOTenum value to theresults/items/payment_statusresponse property for the response status200response-property-enum-value-added
- ●
added the new
UNSPECIFIEDenum value to theresults/items/payment_statusresponse property for the response status200response-property-enum-value-added
- ○
removed the
PAYMENT_STATUS_CANCELEDenum value from theresults/items/payment_statusresponse property for the response status200response-property-enum-value-removed
- ○
removed the
PAYMENT_STATUS_INCOMING_OUTSIDE_CHARIOTenum value from theresults/items/payment_statusresponse property for the response status200response-property-enum-value-removed
- ○
removed the
PAYMENT_STATUS_INCOMING_TO_CHARIOTenum value from theresults/items/payment_statusresponse property for the response status200response-property-enum-value-removed
- ○
removed the
PAYMENT_STATUS_RECEIVED_IN_CHARIOTenum value from theresults/items/payment_statusresponse property for the response status200response-property-enum-value-removed
- ○
removed the
PAYMENT_STATUS_RECEIVED_OUTSIDE_CHARIOTenum value from theresults/items/payment_statusresponse property for the response status200response-property-enum-value-removed
- ○
removed the
PAYMENT_STATUS_UNSPECIFIEDenum value from theresults/items/payment_statusresponse property for the response status200response-property-enum-value-removed
- ●
- ○
added the optional property
results/items/payment_statusto the response with the200statusresponse-optional-property-added
- ○
- ○
added the optional property
results/items/canceled_atto the response with the200statusresponse-optional-property-added
- ○
added the optional property
results/items/individual_gift_amountto the response with the200statusresponse-optional-property-added
- ○
added the optional property
results/items/initiation/allOf[DonationInitiation]/channelto the response with the200statusresponse-optional-property-added
- ○
added the optional property
results/items/initiation/allOf[DonationInitiation]/dafpay_formto the response with the200statusresponse-optional-property-added
- ○