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

The inboundTransfers API from Chariot — 5 operation(s) for inboundtransfers.

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

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

This API exposes 6 operations across 5 paths, and defines 2 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 5 paths 2 schemas 2 GET4 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 inboundTransfers 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 5 paths, the API surfaces 6 operations — 2 GET, 4 POST. Each is listed below with its method, path, parameters, and response codes.

inboundTransfers 6
POST
/v1/inbound_transfers
Create an Inbound transfer
createInboundTransfer 1 param body → 201400401403409500
GET
/v1/inbound_transfers
List Inbound Transfers
listInboundTransfers 2 params → 200400401403404500
GET
/v1/inbound_transfers/{id}
Get an Inbound Transfer
getInboundTransfer 1 param → 200400401403404500
POST
/v1/inbound_transfers/{id}/cancel
Cancel an Inbound Transfer
cancelInboundTransfer 1 param → 200400401403404409412500
POST
/v1/simulations/inbound_transfers/{id}/fail
Sandbox: Fail an Inbound Transfer
simulateInboundTransferFailure 1 param → 202400401403404500
POST
/v1/simulations/inbound_transfers/{id}/complete
Sandbox: Complete an Inbound Transfer
simulateInboundTransferCompletion 1 param → 202400401403404500

Schemas 2

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

InboundTransfer
object
An inbound transfer represents a transfer of funds from an external bank account to a financial account.
6 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

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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