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

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

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

Tagged areas include paymentSources. 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 paymentSources 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.

paymentSources 2
GET
/v1/payment_sources
List Payment Sources
listPaymentSources 2 params → 200400401403500
GET
/v1/payment_sources/{id}
Get a Payment Source
getPaymentSource 1 param → 200400401403404500

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are PaymentSource (8 properties), PostalAddress (6 properties), ProblemDetails (4 properties), AchAddress (2 properties). Each schema is shown below with its type and property counts.

FinancialAddress
object
A subhash containing information about the electronic bank address payment rail details. This is only available for manual and connectedaccount payment sources.
1 property
AchAddress
object
A subhash containing information about the electronic bank address payment rail details.
2 properties 3 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
PaymentSource
object
A Payment Source represents a segregated address for incoming deposits. In practice, this can be separate electronic bank addresses (account + routing numbers)…
8 properties
Lockbox
object
A US mailing address to process incoming physical mail and checks. This is only available for lockbox payment sources.
1 property
PostalAddress
object
A postal address is a mailing address where physical mail can be received. Postal addresses can be used to receive paper checks.
6 properties 5 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

chariot-paymentsources-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