Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Chariot donations API

The donations API from Chariot — 2 operation(s) for donations.

Chariot donations API is one of 29 APIs that Chariot publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include donations. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 2 operations across 2 paths, and defines 15 schemas. It is described by OpenAPI 3.0.0, at version 6.0.

Requests are made against 2 base URLs: https://api.givechariot.com/fdx/v6, https://devapi.givechariot.com/fdx/v6.

2 operations 2 paths 15 schemas 2 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
6.0
Base URL
https://api.givechariot.com
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

Chariot donations API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (oauth2) using the authorizationCode flow, exposing 2 scopes. By default, every request must be authenticated.

  • oauth2 — OAuth 2.0 Bearer token. A client may hold both scopes, but each FDX authorization must contain exactly one — they are mutually exclusive per authorization. An…

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 2 GET. Each is listed below with its method, path, parameters, and response codes.

donations 2
GET
/v1/donations
List Donations
listDonations 6 params → 200400401403500
GET
/v1/donations/{id}
Get a Donation
getDonation 1 param → 200400401403404500

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are Donation (21 properties), DonationInitiation (8 properties), PropertyValue (7 properties), Donor (6 properties). Each schema is shown below with its type and property counts.

PropertyAssignment
object
A property assignment is a key-value pair that is associated with a donation.
2 properties
DonationInitiation
object
If the donation was initiated through a Chariot Connect instance (DAFpay), this object will contain additional information about the initiation of the donation.
8 properties 2 required
Platform
object
A subhash containing information about the platform that facilitated the donation.
4 properties
DonationAttribution
object
A subhash containing information about how the donation is attributed.
2 properties
Artifact
object
An artifact is a source file that was used to create the donation.
4 properties
DafGrant
object
A subhash containing information grant details from a Donor-Advised Fund sponsor.
4 properties 1 required
PlatformAcceptance
object
A subhash containing information about the acceptance of the grant from the platform.
2 properties
DonationSettlement
object
If the payment for the donation was received by Chariot, this object will contain additional information about the settlement of the donation.
3 properties 2 required
Donor
object
The donor information for the transaction
6 properties
PropertyValue
object
7 properties 1 required
Donation
object
A Donation is a gift of money to a nonprofit organization.
21 properties 9 required
Address
object
6 properties 5 required
ProblemDetails
object
RFC 7807 problem-details error (media type application/problem+json). The status field is an integer HTTP status code.
4 properties 4 required
CorporateMatch
object
A subhash containing information about the corporate match for the donation.
4 properties
PropertyType
string
The data type of a property.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

chariot-donations-api-openapi.yml Raw ↑

Other APIs Chariot publishes across the network.

Chariot Accounts API
Chariot Authorization Tokens API
Chariot Connects API
Chariot Contact API
Chariot Customers API
Chariot deposits API
Chariot disbursements API
Chariot Donor Accounts API
Chariot Donor Advised Funds API
Chariot Event Subscriptions API
Chariot Events API
Chariot financial_accounts API