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 Donor Accounts API

The Donor Accounts API from Chariot — 4 operation(s) for donor accounts.

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

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

This API exposes 6 operations across 4 paths, and defines 3 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.

6 operations 4 paths 3 schemas 2 GET1 PATCH3 POST

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 Donor Accounts 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 6

Across 4 paths, the API surfaces 6 operations — 2 GET, 1 PATCH, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Donor Accounts 6
POST
/v1/donor_accounts
Create Donor Account
create-donor-account body → 201400401403409500
GET
/v1/donor_accounts
List Donor Accounts
list-donor-accounts 6 params → 200400401403500
GET
/v1/donor_accounts/{id}
Get Donor Account
get-donor-account 1 param → 200400401403404500
PATCH
/v1/donor_accounts/{id}
Update Donor Account
update-donor-account 1 param body → 200400401403404500
POST
/v1/donor_accounts/{id}/disable
Disable Donor Account
disable-donor-account 1 param → 200400401403404409500
POST
/v1/donor_accounts/{id}/enable
Enable Donor Account
enable-donor-account 1 param → 200400401403404409500

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are DonorAccount (10 properties), ProblemDetails (4 properties). Each schema is shown below with its type and property counts.

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
DonorAccountStatus
string
The status of a [Donor Account](/api/donor-accounts). pending: The Donor Account has been created but the DAF has not yet approved or rejected it. approved: Th…
DonorAccount
object
A Donor Account represents a DAFpay donor identity at a DAF. Donor Accounts are the bridge between a donor's verified DAFpay identity (email, profile) and the…
10 properties 5 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

chariot-donor-accounts-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 donations API
Chariot Donor Advised Funds API
Chariot Event Subscriptions API
Chariot Events API
Chariot financial_accounts API