Obtain an OAuth2 access token using client credentials

Request an access token

Auth

The request is invalid or contains invalid parameters

Unauthorized. The request is missing the security (OAuth2 Bearer token) requirements and the server is unable to verify the identify of the caller.

American Red Cross

The unique federal employer identification number (EIN) of the nonprofit.
This value should be exactly 9 digits and should not contain any special characters such as dashes.

Get nonprofit by EIN

Create nonprofit

Retrieves the nonprofit organization with the given ID.

Get nonprofit

Nonprofits

Simple connect output

The unique id of the nonprofit.
The format should be a v4 UUID according to RFC 4122.

The unique id for the suborganization within the nonprofit.
The format should be a v4 UUID according to RFC 4122.

Create Connect

Get Connect

Connects

Returns a list of all grants for a given Connect. This API allows for paginating over many results.

MoreResults

NoMoreResults

the number of results to return; defaults to 10, max is 100

A token to use to retrieve the next page of results. This is useful for paginating over many pages of results. If set, all other arguments are expected to be kept the same as previous calls and the value of this field should be from the nextPageToken in the previous response.

List Grants

Simple grant output

Create Grant

The unique id of the grant.
The format should be a v4 UUID according to RFC 4122.

Get Grant

Update a grant object with the given ID.
This can be used to update the status or acknowledgement of the grant.

Update Grant

Grants

Returns a list of all recurring grants for a given Connect. This API allows for paginating over many results.

List Recurring Grants

Simple recurring grant output.

Create Recurring Grant

Retrieve a recurring grant with a given ID.

The unique id of the recurring grant.
The format should be a v4 UUID according to RFC 4122.

Get Recurring Grant

Recurring Grants

Returns a list of all unintegrated grants for a given Connect. This API allows for paginating over many results.

List Unintegrated Grants

Retrieve an unintegrated grant with a given ID.

Simple unintegrated grant output

The unique id of the unintegrated grant.
The format should be a v4 UUID according to RFC 4122.

Get Unintegrated Grant

Update an unintegrated grant object with the given ID.
This can be used to update the status or acknowledgement of the unintegrated grant.

Update Unintegrated Grant

Unintegrated Grants

If set to true, filters DAFs to only those that have a direct integration with Chariot.

If included, filters DAFs to only those that contain the query. This parameter is case insensitive.

A token to use to retrieve the next page of results. This is useful for paginating over many pages of results. If set, all other arguments are expected to be kept the same as previous calls.

List DAFs

NPT DAF

The unique id of the DAF.
The format should be a v4 UUID according to RFC 4122.

Get DAF

Da Fs

List all events corresponding to your Chariot account.

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.

Filter Events for those with the specified category.

List Events

Get Event

Events

List all event subscriptions corresponding to your Chariot account.

List Event Subscriptions

Create an event subscription corresponding to your Chariot account.

Create an Event Subscription

Retrieve an event subscription with the given ID.

The unique identifier for the event subscription

Get an Event Subscription

Update an event subscription with the given ID.

Update an Event Subscription

Event Subscriptions

Address

City, district, suburb, town, or village.

Address line 1 (e.g. street, PO Box, or company name)

Address line 2 (e.g. apartment, suite, unit, or building)

Connect

The unique identifier for this object. This is also the 'publishable' cid to use for initializing Connect for client-side integration.

A human readable name for the connect, optional.

A secure token that can be used to make M2M API calls to read data generated by this object.

A flag to indicate if this connect is active. If true, then this Connect can process donations and grants, otherwise this Connect cannot process grants.

Time when this object was created. Expressed in ISO 8601 format.

Time when this object was last updated. Expressed in ISO 8601 format.

A flag to indicate if this object is marked for deletion.

A map of arbitrary string keys and values to store information about the object.

ContributionFeeDetail

The fee contribution amount expressed in units of cents

ContributionFeeDetailFeeType

A flag to indicate if this DAF is supported by DAFpay.

The minimum grant amount in cents allowed for this DAF.

A flag to indicate if the institution is down.

Error

time when the error was reported. Expressed in ISO 8601 format.

A short name of the error; usually the HTTP status.

Events are records of things that happened to objects at Chariot.

Event

The unique identifier for the associated object

The category of the event. This is useful for filtering events.

EventCategory

Webhooks are event notifications we send to you by HTTPS POST requests.
Event Subscriptions are how you configure your application to listen for them.

EventSubscription

The date and time the event subscription was created

The webhook url where we'll send notifications.

EventSubscriptionStatus

A Grant represents a successfully initiated grant request with a Donor Advised Fund. Grants are created when a person interacts with an instance of Chariot Connect and successfully submits a grant and completes the workflow. There can be many grants associated with a Connect object and therefore a Nonprofit.

Grant

Often referred to as the "Chariot ID", this is the ID that will be included in the payment from the DAF provider.

ID of the Connect Workflow Session associated with this grant

ID of the grant associated with the donor advised fund

Time when this object was created; expressed in ISO 8601 format

Time when this object was last updated; expressed in ISO 8601 format

The grant amount expressed in units of whole cents

A map of arbitrary string keys and values to store information about the object

An note inputted by the user at submisson

The list of grant statuses for this grant

GrantAddress

GrantFeeDetail

The total fee amount expressed in units of cents

The list of fee contributions for this grant

GrantPaymentChannel

GrantStatus

The status of the grant. To see a description of each status, see the "Grant Statuses" section of the Chariot documentation.

GrantStatusStatus

A Nonprofit represents a registered 501(c)(3) charitable organization in good standing with the IRS.

Nonprofit

The IRS registered name of the nonprofit organization

The preferred name of the nonprofit organization. This is the name that shows up on the nonprofit's dashboard and Connect modal. This is useful for nonprofits that are known by a different name to donors and don't use their IRS registered name publicly.

The US federal employer identification number (Tax ID); unique on the system. This value should be exactly 9 digits and should not contain any special characters such as dashes.

The list of suborganizations associated with this nonprofit.
Suborganizations are useful for nonprofits that have multiple chapters or locations.

A flag to indicate if the nonprofit will receive grants through the DAFPay Network.
Grants processing through the DAFPay Network will be sent to the DAFPay Network 501(c)(3) non-profit organization (EIN: 93-1372175).
The DAFPay Network will then review and process the grant and send the funds to the nonprofit.
Grants processed outside the DAFPay Network will be sent directly to the nonprofit.

A flag to indicate if the nonprofit is in good standing with the IRS.
If the nonprofit is a tax-exempt 501(c)(3) Public Charity in good standing with the IRS, this field should be true.
This status can change over time and is kept up-to-date by Chariot.
Regardless of the value of this field, Connects can still be created for the nonprofit,
however the nonprofit will not be able to receive grants through Chariot if this field is false.
If you believe the value of this field is incorrect for a Nonprofit, please contact the Chariot team.

A flag to indicate if the nonprofit has been claimed by a user.
A nonprofit is claimed if a user signs up for a Chariot account with
this nonprofit and is verified by the Chariot team.

A RecurringGrant represents a successfully initiated recurring grant request with a Donor Advised Fund.
RecurringGrants are created when a person interacts with an instance of Chariot Connect and successfully submits a recurring grant and completes the workflow.
On creation, each RecurringGrant object will also have a Grant object created to represent the first grant of the recurring grant.
There can be many grants associated with the same recurring grant.

RecurringGrant

How often the DAF provider will submit the recurring grant. At the moment, monthly is the only supported frequency.

A suborganization represents an organization that is under the umbrella of a parent EIN.
This is common for nonprofits that have multiple chapters or locations or operate as a fiscal sponsor.

Suborganization

The registered name of the suborganization

The preferred name of the suborganization. This is the name that shows up on the nonprofit's dashboard and Connect modal. This is useful for nonprofits that are known by a different name to donors and don't use their IRS registered name publicly.

An Unintegrated Grant represents a grant requested through a provider that Chariot does not support.
Unintegrated grants should be treated as donation intents as Chariot can not guarantee that the grant was submitted or will be fulfilled.
Nonprofits should use the information provided in the unintegrated grant to follow up with the donor and/or the provider to check the status of the grant.
These are sometimes refered to as "Manual Grants".

UnintegratedGrant

Often refered to as the "Chariot ID", this is the ID that will be included in the payment from the DAF provider.

The status of the unintegrated grant.
To see a description of each status, see the "Unintegrated Grant Statuses" section of the Chariot documentation.

UnintegratedGrantStatus

GetTokenResponse

DaFsListResponse

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 substituting the pageToken with this value). If specified, then more results exist on the server that were not returned, otherwise no more results exist on the server.

EventSubscriptionsListResponse

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.

EventSubscriptionsUpdateRequestStatus

EventsListResponse

GrantsCreateRequestDonor

GrantsListResponse

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.

1	{
2	"results": [
3	{
4	"id": "1e60800e-849b-43d1-870e-57afc8d75473",
5	"userFriendlyId": "chariot-1234455",
6	"trackingId": "L9E182VBGP",
7	"workflowSessionId": "cfe09e64-6a74-4dab-a565-361185a6f248",
8	"fundId": "daf-id",
9	"externalGrantId": "897823sdjf8sfjs",
10	"createdAt": "2021-08-10T15:00:00Z",
11	"updatedAt": "2021-08-11T15:34:00Z",
12	"amount": 15000,
13	"status": "Initiated",
14	"feeDetail": {
15	"total": 1500,
16	"contributions": [
17	{
18	"name": "Chariot",
19	"amount": 1500
20	}
21	]
22	},
23	"metadata": {
24	"key": "value"
25	},
26	"firstName": "Warren",
27	"lastName": "Buffet",
28	"phone": "1237861020",
29	"email": "warrenBuffet@example.com",
30	"note": "Please dedicate in memory of grandma",
31	"statuses": [
32	{
33	"id": "cfe09e64-6a74-4dab-a565-361185a6f248",
34	"createdAt": "2020-07-10T15:00:00Z",
35	"status": "Initiated",
36	"comment": "The grant has been received by the nonprofit"
37	}
38	],
39	"paymentChannel": "dafpay_network"
40	}
41	],
42	"nextPageToken": "c3f685f2-2dda-4956-815b-39867a5e5638"
43	}

List Grants

Headers

Query parameters

Response

Errors

1	curl https://api.givechariot.com/v1/grants \
2	-H "x-chariot-api-key: live_xJd0lUrvpDkzeGBWZbuI2wbvEdM" \
3	-H "Authorization: Bearer <token>"