Chariot disbursements API
The disbursements API from Chariot — 9 operation(s) for disbursements.
Chariot disbursements API is one of 29 APIs that Chariot publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include disbursements. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes 10 operations across 9 paths, and defines 36 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.
10 operations
9 paths
36 schemas
2 GET8 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Chariot disbursements 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 10
Across 9 paths, the API surfaces 10 operations — 2 GET, 8 POST. Each is listed below with its method, path, parameters, and response codes.
disbursements 10
POST
/v1/disbursements
Create a disbursement
GET
/v1/disbursements
List disbursements
POST
/v1/disbursements/bulk
Create multiple disbursements
GET
/v1/disbursements/{id}
Get a disbursement
POST
/v1/disbursements/{id}/approve
Approve a disbursement
POST
/v1/disbursements/approve
Approve multiple disbursements
POST
/v1/disbursements/{id}/cancel
Cancel a pending disbursement
POST
/v1/disbursements/{id}/stop
Stop payment for a disbursement
POST
/v1/simulations/disbursements/{id}/complete
Sandbox: Complete a disbursement
POST
/v1/simulations/disbursements/{id}/fail
Sandbox: Fail a disbursement
Schemas 36
The contract defines 36 schemas that model the data the API accepts and returns. The most detailed are Disbursement (20 properties), CheckTransfer (16 properties), Transaction (15 properties), AchTransfer (14 properties). Each schema is shown below with its type and property counts.
CheckTransfer
object
A check transfer represents a paper check that is mailed to the receiving organization.
16 properties
7 required
DisbursementApproval
object
If your account requires approvals for disbursements and the disbursement was approved, this will contain the details of the approval.
2 properties
DisbursementVerification
object
If the disbursement has been verified by Chariot, this will contain the verification details.
1 property
ProgramDetails
object
Details about the program that the disbursement belongs to.
2 properties
TransactionCorporateMatch
object
A corporate matching gift. Required when the transaction type is corporatematch.
1 property
1 required
AccountTransfer
object
An account transfer represents an instant, electronic transfer of funds.
5 properties
5 required
Person
object
A person is an individual who is an officer of a nonprofit.
2 properties
1 required
CreateDisbursementInput
object
The request to create a disbursement and its corresponding transactions. The organization and amount are required. The transactions array should contain the li…
6 properties
3 required
NonprofitClassification
object
A classification of the nonprofit entity as defined by the IRS.
10 properties
PostalTrackingUpdate
object
The postal tracking update for the check
3 properties
3 required
ComplianceRequirement
object
A compliance requirement is a requirement that a nonprofit entity must meet in order to be eligible for Chariot services.
3 properties
NonprofitCompliance
object
An object that contains legal information about the nonprofit entity and its tax-exemption status. This information is used to comply with regulations and ensu…
6 properties
Incorporation
object
Incorporation and IRS determination information for the nonprofit entity.
3 properties
DisbursementStatus
string
The lifecycle status of the disbursement. Possible values include: - pendingapproval: The disbursement is awaiting approval from the grantmaker - canceled: The…
NteeCode
object
A code that is used to classify the nonprofit entity as defined by the IRS.
4 properties
2 required
Transaction
object
A transaction represents an individual line-item or donation for a recipient nonprofit organization. The transaction amount represents the gross amount, and an…
15 properties
3 required
DisbursementCancelation
object
If your account requires approvals for disbursements and the disbursement was not approved, this will contain the details of the cancelation.
2 properties
Brand
object
Fair use brand assets that are associated with an organization and can be used for identification and informational purposes.
2 properties
Disbursement
object
A disbursement moves funds to a verified organization.
20 properties
4 required
TransactionDafGrant
object
A simplified DAF grant object containing the fund name.
1 property
StopDisbursementPaymentReason
string
The reason for stopping a disbursement payment. Possible values include: - maildeliveryfailure: The check could not be delivered. - notauthorized: The check wa…
Donor
object
The donor information for the transaction
6 properties
DisbursementTransfer
object
After a disbursement is submitted, this object contains additional details about the transfer. This is useful if you want to track the disbursement over the sp…
4 properties
TransactionDonors
object
Information about the individuals associated with the gift. Includes a primary donor and an optional joint donor.
2 properties
DisbursementStop
object
If the disbursement was stopped by the grantmaker after it was submitted, this will contain the details of the stop.
2 properties
NaicsCode
object
A code that is used to classify the nonprofit entity as defined by the NAICS.
6 properties
DisbursementRejection
object
If the disbursement was rejected by Chariot, this will contain details as to why the disbursement was rejected.
2 properties
Address
object
6 properties
5 required
TaxExemptCode
object
A tax exempt code is a code that is used to classify the tax-exempt status of a nonprofit entity.
3 properties
2 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
Organization
object
An Organization represents an operating nonprofit or an operating sub-organization of a parent or sponsoring nonprofit. The generally accepted identifier for a…
13 properties
3 required
DonationType
string
The type of donation
RealTimePaymentsTransfer
object
A real-time payments transfer represents an instant, electronic transfer of funds.
11 properties
7 required
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
WebDomain
object
A web domain is a unique identifier for a website or web application that is associated with an organization. Domains are important identity constructs that un…
1 property
1 required
AchTransfer
object
An ACH transfer represents an electronic transfer of funds via the Automated Clearing House (ACH) payment network.
14 properties
4 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Chariot 12
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 donations API
Chariot Donor Accounts API
Chariot Donor Advised Funds API
Chariot Event Subscriptions API
Chariot Events API
Chariot financial_accounts API
#disbursements