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

Account statements and statement documents

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

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

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

Statements 2

Account statements and statement documents

GET
/accounts/{id}/statements
List account statements
listAccountStatements 5 params → 200400401403404500
GET
/accounts/{id}/statements/{statementId}
Get account statement
getAccountStatement 2 params → 200400401403404406500

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are Statement (6 properties), ProblemDetails (5 properties), ListStatementsResponse (2 properties), Page (2 properties). Each schema is shown below with its type and property counts.

Link
object
A hyperlink reference.
1 property 1 required
DocumentStatus
string
Status of a document
Page
object
Pagination metadata for list responses.
2 properties
ListStatementsResponse
object
Paginated list of statements.
2 properties 1 required
ProblemDetails
object
Error response following RFC 7807 Problem Details for HTTP APIs.
5 properties 3 required
Statement
object
A bank account statement.
6 properties 5 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

chariot-statements-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 Accounts API
Chariot Donor Advised Funds API
Chariot Event Subscriptions API
Chariot Events API