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 deposits API

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

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

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

This API exposes 2 operations across 2 paths, and defines 9 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 9 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 deposits 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.

deposits 2
GET
/v1/deposits
List Deposits
listDeposits 5 params → 200400401403500
GET
/v1/deposits/{id}
Get a Deposit
getDeposit 1 param → 200400401403404500

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are Deposit (10 properties), PropertyValue (7 properties), InboundAchTransfer (7 properties), Transfer (7 properties). Each schema is shown below with its type and property counts.

InboundAchTransfer
object
An ACH transfer initiated outside of Chariot to your financial account.
7 properties
CheckDeposit
object
A check deposit represents a physical check that is deposited into a financial account.
4 properties
PropertyAssignment
object
A property assignment is a key-value pair that is associated with a donation.
2 properties
InboundAccountTransfer
object
An instant transfer of funds between two financial accounts. This is the preferred method of transferring funds for Grantmakers within Chariot's Network.
1 property 1 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
PropertyType
string
The data type of a property.
Deposit
object
A Deposit is a transfer of money for a charitable donation or a batch of donations.
10 properties 6 required
PropertyValue
object
7 properties 1 required
Transfer
object
A subhash containing information about the transfer associated with the deposit.
7 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

chariot-deposits-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 disbursements API
Chariot donations API
Chariot Donor Accounts API
Chariot Donor Advised Funds API
Chariot Event Subscriptions API
Chariot Events API
Chariot financial_accounts API