openapi: 3.0.0 info: title: Chariot API version: "v1" description: The Chariot REST API. Please see https://docs.givechariot.com/api for more details. contact: name: Chariot Development Team url: https://givechariot.com/contact email: developers@givechariot.com termsOfService: https://givechariot.com/legal-nonprofit servers: - url: https://sandboxapi.givechariot.com description: Sandbox - url: https://api.givechariot.com description: Production paths: /v1/organizations/search: get: summary: Search organizations description: |- Search for organizations by name or EIN. This endpoint exists to support a typeahead search or quick lookup by nonprofit EIN or name. The Get Organization API should be used to retrieve detailed information about an organization. operationId: searchOrganizations tags: - Organizations security: - bearerAuth: [] parameters: - name: q in: query required: true description: |- The query string to search for. If this is in the format of an EIN, the search will be limited exclusively to the organization with that EIN. Otherwise, this will be a fuzzy search on organization name. schema: type: string - name: ein in: query description: |- The Employer Identification Number (EIN) or TaxID for the nonprofit entity. This is deprecated in favor of the `q` parameter. schema: type: string deprecated: true - name: name in: query description: |- The name of the organization. This is deprecated in favor of the `q` parameter. schema: type: string deprecated: true - name: limit in: query description: Limit the size of the list that is returned. The default (and maximum) is 20 objects. required: false schema: type: integer format: int32 responses: "200": $ref: "#/components/responses/SearchOrganizationsResponse" "400": $ref: "#/components/responses/BadRequestError" "401": $ref: "#/components/responses/AuthenticationError" "403": $ref: "#/components/responses/ForbiddenError" "500": $ref: "#/components/responses/InternalServerError" /v1/organizations/{id}: get: summary: Get organization description: |- Retrieves the organization with the given ID. operationId: getOrganization tags: - Organizations security: - bearerAuth: [] parameters: - name: id in: path description: The unique identifier for the organization schema: type: string required: true example: "org_1LaXpKGUcADgqoEMl0Cx0Ygg" responses: "200": description: "OK" headers: X-Request-Id: $ref: "#/components/headers/X-Request-Id" content: application/json: schema: $ref: "#/components/schemas/Organization" "400": $ref: "#/components/responses/BadRequestError" "401": $ref: "#/components/responses/AuthenticationError" "403": $ref: "#/components/responses/ForbiddenError" "404": $ref: "#/components/responses/NotFoundError" "500": $ref: "#/components/responses/InternalServerError" /v1/programs: get: summary: List Programs description: |- Returns a list of all programs for your Chariot account. operationId: list-programs tags: - Programs security: - bearerAuth: [] parameters: - name: limit in: query description: Number of results per page. The default (and maximum) is 100 objects. required: false schema: type: integer format: int32 - name: cursor in: query description: |- Cursor token for pagination. Use the next_page_token from the previous response to retrieve the next page of results. required: false schema: type: string responses: "200": $ref: "#/components/responses/ListProgramsResponse" "400": $ref: "#/components/responses/BadRequestError" "401": $ref: "#/components/responses/AuthenticationError" "403": $ref: "#/components/responses/ForbiddenError" "500": $ref: "#/components/responses/InternalServerError" /v1/programs/{id}: get: summary: Get Program description: |- Retrieves the program with the given ID. operationId: get-program tags: - Programs security: - bearerAuth: [] parameters: - name: id in: path description: The unique identifier for the program schema: type: string required: true example: "program_01j8rs605a4gctmbm58d87mvsj" responses: "200": description: OK headers: X-Request-Id: $ref: "#/components/headers/X-Request-Id" content: application/json: schema: $ref: "#/components/schemas/Program" "400": $ref: "#/components/responses/BadRequestError" "401": $ref: "#/components/responses/AuthenticationError" "403": $ref: "#/components/responses/ForbiddenError" "404": $ref: "#/components/responses/NotFoundError" "500": $ref: "#/components/responses/InternalServerError" /v1/connects: post: summary: Create Connect description: |- Get an existing connect or create a new connect for an existing nonprofit organization. The returned Connect can be used to integrate the client-side Chariot Connect component using the `id` property (CID) and also query for data generated from the Chariot Connect instance using the connect_id query parameter in any of the List Grants API endpoints. Only one Connect object can be created per organization. If one already exists, this will return a `200 OK` status with the existing object. operationId: create-connect tags: - Connects security: - bearerAuth: [] requestBody: $ref: "#/components/requestBodies/CreateConnectRequest" responses: "200": description: OK headers: X-Request-Id: $ref: "#/components/headers/X-Request-Id" Location: $ref: "#/components/headers/Location" content: application/json: schema: $ref: "#/components/schemas/Connect" examples: Simple: $ref: "#/components/examples/ConnectOutput" "201": description: Created headers: X-Request-Id: $ref: "#/components/headers/X-Request-Id" Location: $ref: "#/components/headers/Location" content: application/json: schema: $ref: "#/components/schemas/Connect" examples: Simple: $ref: "#/components/examples/ConnectOutput" "400": $ref: "#/components/responses/BadRequestError" "401": $ref: "#/components/responses/AuthenticationError" "403": $ref: "#/components/responses/ForbiddenError" "404": $ref: "#/components/responses/NotFoundError" "500": $ref: "#/components/responses/InternalServerError" /v1/connects/{id}: get: summary: Get Connect description: |- Retrieve a connect with the given ID. operationId: get-connect tags: - Connects security: - bearerAuth: [] parameters: - name: id in: path description: the unique id of the connect schema: type: string required: true example: live_xJd0lUrvpDkzeGBWZbuI2wbvEdM responses: "200": description: "OK" headers: X-Request-Id: $ref: "#/components/headers/X-Request-Id" content: application/json: schema: $ref: "#/components/schemas/Connect" "400": $ref: "#/components/responses/BadRequestError" "401": $ref: "#/components/responses/AuthenticationError" "403": $ref: "#/components/responses/ForbiddenError" "404": $ref: "#/components/responses/NotFoundError" "500": $ref: "#/components/responses/InternalServerError" /v1/grants: get: summary: List Grants description: |- Returns a list of all grants for a given Connect. This API allows for paginating over many results. operationId: list-grants tags: - Grants security: - bearerAuth: [] parameters: - name: connect_id in: query description: the `id` of the Connect object. This can be used to filter the grants by a specific Connect if you have more than one. schema: type: string required: false example: "live_2d821da0ed8bc7256e260f4eb5244f2d8f06c576342f922ba2f0a416d8c98002" - name: pageLimit in: query description: the number of results to return; defaults to 10, max is 100 schema: type: integer default: 10 - name: pageToken in: query description: |- A token to use to retrieve the next page of results. This is useful for paginating over many pages of results. If set, all other arguments are expected to be kept the same as previous calls and the value of this field should be from the nextPageToken in the previous response. schema: type: string responses: "200": $ref: "#/components/responses/ListGrantsResponse" "400": $ref: "#/components/responses/BadRequestError" "401": $ref: "#/components/responses/AuthenticationError" "403": $ref: "#/components/responses/ForbiddenError" "500": $ref: "#/components/responses/InternalServerError" post: summary: Create Grant description: |- Create and submit a new grant. This should be used to capture a grant intent from an authorized DAFpay workflow session and submit the grant request to the DAF sponsor. On initial creation of the grant, this request will return a 201 Created status. On subsequent requests, the request will return status 200 OK. Error handling: - The grant must be captured within 15 minutes of authorization otherwise the request will return status `410 Gone`. - If this request is submitted while this grant is already being processed, the request will return status `409 Conflict`. - The amount must be in whole dollar increments (rounded to the nearest hundred) as currently DAFs only accept whole dollar grants otherwise the request will return status `400 Bad Request`. - The amount must be greater than or equal to the minimum grant amount for the DAF otherwise the request will return status `400 Bad Request`. - The amount must be less than or equal to the user's DAF account balance otherwise the request will return status `400 Bad Request`. - Any inputs exceeding the maximum allowed length will be automatically truncated. operationId: create-grant tags: - Grants security: - bearerAuth: [] requestBody: $ref: "#/components/requestBodies/GrantCaptureRequest" responses: "201": description: Created headers: X-Request-Id: $ref: "#/components/headers/X-Request-Id" Location: description: The URI reference of the created grant object. schema: type: string format: uri content: application/json: schema: $ref: "#/components/schemas/Grant" examples: Simple: $ref: "#/components/examples/GrantOutput" "200": description: The grant content: application/json: schema: $ref: "#/components/schemas/Grant" examples: Simple: $ref: "#/components/examples/GrantOutput" "400": $ref: "#/components/responses/BadRequestError" "401": $ref: "#/components/responses/AuthenticationError" "403": $ref: "#/components/responses/ForbiddenError" "404": $ref: "#/components/responses/NotFoundError" "409": $ref: "#/components/responses/ConflictError" "410": $ref: "#/components/responses/GoneError" "500": $ref: "#/components/responses/InternalServerError" /v1/grants/{id}: get: summary: Get Grant description: |- Retrieve a grant with the given ID. operationId: get-grant tags: - Grants security: - bearerAuth: [] parameters: - name: id in: path description: |- The unique id of the grant. The format should be a v4 UUID according to RFC 4122. schema: type: string format: uuid required: true example: 10229488-08d2-4629-b70c-a2f4f4d25344 responses: "200": description: OK headers: X-Request-Id: $ref: "#/components/headers/X-Request-Id" content: application/json: schema: $ref: "#/components/schemas/Grant" examples: Simple: $ref: "#/components/examples/GrantOutput" "400": $ref: "#/components/responses/BadRequestError" "401": $ref: "#/components/responses/AuthenticationError" "403": $ref: "#/components/responses/ForbiddenError" "404": $ref: "#/components/responses/NotFoundError" "500": $ref: "#/components/responses/InternalServerError" /v1/recurring_grants: get: summary: List Recurring Grants description: |- Returns a list of all recurring grants for a given Connect. This API allows for paginating over many results. operationId: list-recurring-grants tags: - recurring_grants security: - bearerAuth: [] parameters: - name: connect_id in: query description: the `id` of the Connect object. This can be used to filter the recurring grants by a specific Connect if you have more than one. schema: type: string required: false example: "live_2d821da0ed8bc7256e260f4eb5244f2d8f06c576342f922ba2f0a416d8c98002" - name: pageLimit in: query description: the number of results to return; defaults to 10, max is 100 schema: type: integer default: 10 - name: pageToken in: query description: |- A token to use to retrieve the next page of results. This is useful for paginating over many pages of results. If set, all other arguments are expected to be kept the same as previous calls and the value of this field should be from the nextPageToken in the previous response. schema: type: string responses: "200": $ref: "#/components/responses/ListRecurringGrantsResponse" "400": $ref: "#/components/responses/BadRequestError" "401": $ref: "#/components/responses/AuthenticationError" "403": $ref: "#/components/responses/ForbiddenError" "500": $ref: "#/components/responses/InternalServerError" post: summary: Create Recurring Grant description: |- Create and submit a new recurring grant. This should be used to capture a recurring grant intent from an authorized DAFpay workflow session and submit the recurring grant request to the DAF sponsor. Error handling: - The recurring grant must be captured within 15 minutes of authorization otherwise the request will return status `410 Gone`. - A recurring grant can only be captured once from any given workflow session so any duplicate requests will return status `409 Conflict`. - The amount must be in whole dollar increments (rounded to the nearest hundred) as currently DAFs only accept whole dollar grants otherwise the request will return status `400 Bad Request`. - The amount must be greater than or equal to the minimum grant amount for the DAF otherwise the request will return status `400 Bad Request`. - The amount must be less than or equal to the user's DAF account balance otherwise the request will return status `400 Bad Request`. - Any inputs exceeding the maximum allowed length will be automatically truncated unless otherwise stated. operationId: create-recurring-grant tags: - recurring_grants security: - bearerAuth: [] requestBody: $ref: "#/components/requestBodies/RecurringGrantCaptureRequest" responses: "201": description: Created recurring grant headers: X-Request-Id: $ref: "#/components/headers/X-Request-Id" Location: description: The URI reference of the created recurring grant object. schema: type: string format: uri content: application/json: schema: $ref: "#/components/schemas/RecurringGrant" examples: Simple: $ref: "#/components/examples/RecurringGrantOutput" "400": $ref: "#/components/responses/BadRequestError" "401": $ref: "#/components/responses/AuthenticationError" "403": $ref: "#/components/responses/ForbiddenError" "404": $ref: "#/components/responses/NotFoundError" "409": $ref: "#/components/responses/ConflictError" "410": $ref: "#/components/responses/GoneError" "500": $ref: "#/components/responses/InternalServerError" /v1/recurring_grants/{id}: get: summary: Get Recurring Grant description: |- Retrieve a recurring grant with a given ID. operationId: get-recurring-grant tags: - recurring_grants security: - bearerAuth: [] parameters: - name: id in: path description: |- The unique id of the recurring grant. The format should be a v4 UUID according to RFC 4122. schema: type: string format: uuid required: true example: 10229488-08d2-4629-b70c-a2f4f4d25344 responses: "200": description: OK headers: X-Request-Id: $ref: "#/components/headers/X-Request-Id" content: application/json: schema: $ref: "#/components/schemas/RecurringGrant" examples: Simple: $ref: "#/components/examples/RecurringGrantOutput" "400": $ref: "#/components/responses/BadRequestError" "401": $ref: "#/components/responses/AuthenticationError" "403": $ref: "#/components/responses/ForbiddenError" "404": $ref: "#/components/responses/NotFoundError" "500": $ref: "#/components/responses/InternalServerError" /v1/unintegrated_grants: get: summary: List Unintegrated Grants description: |- Returns a list of all unintegrated grants for a given Connect. This API allows for paginating over many results. operationId: list-unintegrated-grants tags: - unintegrated_grants security: - bearerAuth: [] parameters: - name: connect_id in: query description: the `id` of the Connect object. This can be used to filter the unintegrated grants by a specific Connect if you have more than one. schema: type: string required: false example: "live_2d821da0ed8bc7256e260f4eb5244f2d8f06c576342f922ba2f0a416d8c98002" - name: pageLimit in: query description: the number of results to return; defaults to 10, max is 100 schema: type: integer default: 10 - name: pageToken in: query description: |- A token to use to retrieve the next page of results. This is useful for paginating over many pages of results. If set, all other arguments are expected to be kept the same as previous calls and the value of this field should be from the nextPageToken in the previous response. schema: type: string responses: "200": $ref: "#/components/responses/ListUnintegratedGrantsResponse" "400": $ref: "#/components/responses/BadRequestError" "401": $ref: "#/components/responses/AuthenticationError" "403": $ref: "#/components/responses/ForbiddenError" "500": $ref: "#/components/responses/InternalServerError" /v1/unintegrated_grants/{id}: get: summary: Get Unintegrated Grant description: |- Retrieve an unintegrated grant with a given ID. operationId: get-unintegrated-grant tags: - unintegrated_grants security: - bearerAuth: [] parameters: - name: id in: path description: |- The unique id of the unintegrated grant. The format should be a v4 UUID according to RFC 4122. schema: type: string format: uuid required: true example: 10229488-08d2-4629-b70c-a2f4f4d25344 responses: "200": description: OK headers: X-Request-Id: $ref: "#/components/headers/X-Request-Id" content: application/json: schema: $ref: "#/components/schemas/UnintegratedGrant" examples: Simple: $ref: "#/components/examples/UnintegratedGrantOutput" "400": $ref: "#/components/responses/BadRequestError" "401": $ref: "#/components/responses/AuthenticationError" "403": $ref: "#/components/responses/ForbiddenError" "404": $ref: "#/components/responses/NotFoundError" "500": $ref: "#/components/responses/InternalServerError" /v1/dafs: get: summary: List Donor Advised Funds description: |- Returns a list of all Donor Advised Funds within Chariot's system. This API allows for paginating over many results. If there are DAFs missing from the list, please contact support at support@givechariot.com. operationId: list-dafs tags: - Donor Advised Funds security: - bearerAuth: [] parameters: - name: supportedOnly in: query description: |- If set to true, filters DAFs to only those that have a direct integration with Chariot. schema: type: boolean default: false - name: query in: query description: |- If included, filters DAFs to only those that contain the query. This parameter is case insensitive. schema: type: string - name: pageLimit in: query description: the number of results to return; defaults to 10, max is 100 schema: type: integer default: 10 - name: pageToken in: query description: |- A token to use to retrieve the next page of results. This is useful for paginating over many pages of results. If set, all other arguments are expected to be kept the same as previous calls. schema: type: string responses: "200": $ref: "#/components/responses/ListDafsResponse" "400": $ref: "#/components/responses/BadRequestError" "401": $ref: "#/components/responses/AuthenticationError" "500": $ref: "#/components/responses/InternalServerError" /v1/dafs/{id}: get: summary: Get Donor Advised Fund description: |- Retrieve a DAF with a given ID. operationId: get-daf tags: - Donor Advised Funds security: - bearerAuth: [] parameters: - name: id in: path description: |- The unique id of the DAF. The format should be a v4 UUID according to RFC 4122. schema: type: string format: uuid required: true example: f9e28217-e0f7-4a54-9764-d664ffb10722 responses: "200": description: "OK" headers: X-Request-Id: $ref: "#/components/headers/X-Request-Id" content: application/json: schema: $ref: "#/components/schemas/Daf" examples: Npt: $ref: "#/components/examples/DafOutput" "400": $ref: "#/components/responses/BadRequestError" "401": $ref: "#/components/responses/AuthenticationError" "404": $ref: "#/components/responses/NotFoundError" "500": $ref: "#/components/responses/InternalServerError" /v1/events: get: summary: List Events description: |- List all events corresponding to your Chariot account. operationId: listEvents tags: - Events security: - bearerAuth: [] parameters: - name: limit in: query description: Limit the size of the list that is returned. The default (and maximum) is 100 objects. required: false schema: type: integer format: int32 - name: cursor in: query description: The cursor to use for pagination. If not set, the first page of results will be returned. required: false schema: type: string - name: category in: query description: | Filter Events for those with the specified category. required: false schema: $ref: "#/components/schemas/EventCategory" responses: "200": $ref: "#/components/responses/ListEventsResponse" "400": $ref: "#/components/responses/BadRequestError" "401": $ref: "#/components/responses/AuthenticationError" "403": $ref: "#/components/responses/ForbiddenError" "500": $ref: "#/components/responses/InternalServerError" /v1/events/{id}: get: summary: Get Event description: |- Retrieve an event with the given ID. operationId: getEvent tags: - Events security: - bearerAuth: [] parameters: - name: id in: path description: The unique id for the event required: true schema: type: string responses: "200": description: OK content: application/json: schema: $ref: "#/components/schemas/Event" "400": $ref: "#/components/responses/BadRequestError" "401": $ref: "#/components/responses/AuthenticationError" "403": $ref: "#/components/responses/ForbiddenError" "404": $ref: "#/components/responses/NotFoundError" "500": $ref: "#/components/responses/InternalServerError" /v1/event_subscriptions: post: summary: Create an Event Subscription description: |- Create an event subscription corresponding to your Chariot account. operationId: createEventSubscription tags: - Event Subscriptions security: - bearerAuth: [] requestBody: $ref: "#/components/requestBodies/CreateEventSubscriptionRequest" responses: "201": description: Created headers: Location: $ref: "#/components/headers/Location" content: application/json: schema: $ref: "#/components/schemas/EventSubscription" "400": $ref: "#/components/responses/BadRequestError" "401": $ref: "#/components/responses/AuthenticationError" "403": $ref: "#/components/responses/ForbiddenError" "404": $ref: "#/components/responses/NotFoundError" "500": $ref: "#/components/responses/InternalServerError" get: summary: List Event Subscriptions description: |- List all event subscriptions corresponding to your Chariot account. operationId: listEventSubscriptions tags: - Event Subscriptions security: - bearerAuth: [] parameters: - name: limit in: query description: Limit the size of the list that is returned. The default (and maximum) is 100 objects. required: false schema: type: integer format: int32 - name: cursor in: query description: The cursor to use for pagination. If not set, the first page of results will be returned. required: false schema: type: string responses: "200": $ref: "#/components/responses/ListEventSubscriptionsResponse" "400": $ref: "#/components/responses/BadRequestError" "401": $ref: "#/components/responses/AuthenticationError" "403": $ref: "#/components/responses/ForbiddenError" "500": $ref: "#/components/responses/InternalServerError" /v1/event_subscriptions/{id}: get: summary: Get an Event Subscription description: |- Retrieve an event subscription with the given ID. operationId: getEventSubscription tags: - Event Subscriptions security: - bearerAuth: [] parameters: - name: id in: path description: The unique identifier for the event subscription required: true schema: type: string responses: "200": description: OK content: application/json: schema: $ref: "#/components/schemas/EventSubscription" "400": $ref: "#/components/responses/BadRequestError" "401": $ref: "#/components/responses/AuthenticationError" "403": $ref: "#/components/responses/ForbiddenError" "404": $ref: "#/components/responses/NotFoundError" "500": $ref: "#/components/responses/InternalServerError" patch: summary: Update an Event Subscription description: |- Update an event subscription with the given ID. operationId: updateEventSubscription tags: - Event Subscriptions security: - bearerAuth: [] parameters: - name: id in: path description: The unique identifier for the event subscription required: true schema: type: string requestBody: $ref: "#/components/requestBodies/UpdateEventSubscriptionRequest" responses: "200": description: Updated content: application/json: schema: $ref: "#/components/schemas/EventSubscription" "400": $ref: "#/components/responses/BadRequestError" "401": $ref: "#/components/responses/AuthenticationError" "403": $ref: "#/components/responses/ForbiddenError" "404": $ref: "#/components/responses/NotFoundError" "500": $ref: "#/components/responses/InternalServerError" /v1/financial_accounts: get: summary: List financial accounts description: | Returns a list of financial accounts. operationId: listFinancialAccounts tags: - financial_accounts parameters: - name: program_id in: query description: The unique identifier for the program required: false schema: type: string example: "program_01jpjenf5q6cawy43yxfcrxhct" - name: page_limit in: query description: Limit the size of the list that is returned. The default (and maximum) is 100 objects. required: false schema: type: integer format: int32 - name: next_page_token in: query description: |- A token to use to retrieve the next page of results. This is useful for paginating over many pages of results. If set, all other arguments are expected to be kept the same as previous calls and the value of this field should be from the nextPageToken in the previous response. required: false schema: type: string security: - bearerAuth: [] responses: "200": $ref: "#/components/responses/ListFinancialAccountsResponse" "400": $ref: "#/components/responses/BadRequestError" "401": $ref: "#/components/responses/AuthenticationError" "403": $ref: "#/components/responses/ForbiddenError" "500": $ref: "#/components/responses/InternalServerError" /v1/financial_accounts/{id}: get: summary: Get a financial account description: | Get a financial account by its unique identifier. operationId: getFinancialAccount tags: - financial_accounts security: - bearerAuth: [] parameters: - name: id in: path description: The unique identifier for the financial account required: true schema: type: string example: "account_01jpjenf5q6cawy43yxfcrxhct" responses: "200": description: The financial account was retrieved content: application/json: schema: $ref: "#/components/schemas/FinancialAccount" "400": $ref: "#/components/responses/BadRequestError" "401": $ref: "#/components/responses/AuthenticationError" "403": $ref: "#/components/responses/ForbiddenError" "404": $ref: "#/components/responses/NotFoundError" "500": $ref: "#/components/responses/InternalServerError" /v1/financial_accounts/{id}/balance: get: summary: Get a financial account balance description: | Get a financial account balance by its unique identifier. operationId: getFinancialAccountBalance tags: - financial_accounts security: - bearerAuth: [] parameters: - name: id in: path description: The unique identifier for the financial account required: true schema: type: string example: "account_01jpjenf5q6cawy43yxfcrxhct" responses: "200": description: The financial account was retrieved content: application/json: schema: $ref: "#/components/schemas/FinancialAccountBalance" "400": $ref: "#/components/responses/BadRequestError" "401": $ref: "#/components/responses/AuthenticationError" "403": $ref: "#/components/responses/ForbiddenError" "404": $ref: "#/components/responses/NotFoundError" "500": $ref: "#/components/responses/InternalServerError" /v1/disbursements: post: summary: Create a disbursement description: | Create a disbursement to send money to an organization. If the program specified does not have grant_disbursement_status enabled or if no grant_disbursement_status enabled program exists for your account, this will return a 403 Forbidden error. If your Chariot account has multiple grant_disbursement_status enabled programs, you must specify the program_id to use for the disbursement otherwise the request will return a 400 Bad Request error. operationId: createDisbursement tags: - disbursements security: - bearerAuth: [] requestBody: $ref: "#/components/requestBodies/CreateDisbursementRequest" responses: "201": description: The disbursement was created headers: Location: $ref: "#/components/headers/Location" content: application/json: schema: $ref: "#/components/schemas/Disbursement" "400": $ref: "#/components/responses/BadRequestError" "401": $ref: "#/components/responses/AuthenticationError" "403": $ref: "#/components/responses/ForbiddenError" "409": $ref: "#/components/responses/ConflictError" get: summary: List disbursements description: | Returns a list of disbursements. operationId: listDisbursements tags: - disbursements security: - bearerAuth: [] parameters: - name: organization_id in: query description: The unique identifier for the recipient organization required: false schema: type: string example: "org_01j8rs605a4gctmbm58d87mvsj" - name: program_id in: query description: The unique identifier for the program required: false schema: type: string example: "program_01jpjenf5q6cawy43yxfcrxhct" - name: page_limit in: query description: Limit the size of the list that is returned. The default (and maximum) is 100 objects. required: false schema: type: integer format: int32 - name: next_page_token in: query description: |- A token to use to retrieve the next page of results. This is useful for paginating over many pages of results. If set, all other arguments are expected to be kept the same as previous calls and the value of this field should be from the nextPageToken in the previous response. required: false schema: type: string - name: includes in: query description: |- A comma separated list of fields to include in the response. Possible values include: - `organization`: Include the organization object in the response. required: false schema: type: string example: "organization" responses: "200": $ref: "#/components/responses/ListDisbursementsResponse" "400": $ref: "#/components/responses/BadRequestError" "401": $ref: "#/components/responses/AuthenticationError" "403": $ref: "#/components/responses/ForbiddenError" "500": $ref: "#/components/responses/InternalServerError" /v1/disbursements/bulk: post: summary: Create multiple disbursements description: | Create multiple disbursements in a single request. This is useful for batch operations where you need to create many disbursements at once. All disbursements in the request will be created together. If any disbursement fails validation, the entire request will fail and no disbursements will be created. If any of the disbursements in the request have a program specified that does not have grant_disbursement_status enabled or if no grant_disbursement_status enabled program exists for your account, the request will return a 403 Forbidden error. If your Chariot account has multiple grant_disbursement_status enabled programs, you must specify the program_id to use for the disbursements otherwise the request will return a 400 Bad Request error. operationId: bulkCreateDisbursements tags: - disbursements security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object required: - disbursements properties: disbursements: type: array description: Array of disbursements to create minItems: 1 items: $ref: "#/components/schemas/CreateDisbursementInput" responses: "201": description: The disbursements were created content: application/json: schema: type: object required: - disbursements - count properties: disbursements: type: array items: $ref: "#/components/schemas/Disbursement" count: type: integer description: The number of disbursements created example: 5 "400": $ref: "#/components/responses/BadRequestError" "401": $ref: "#/components/responses/AuthenticationError" "403": $ref: "#/components/responses/ForbiddenError" "409": $ref: "#/components/responses/ConflictError" /v1/disbursements/{id}: get: summary: Get a disbursement description: | Get a disbursement by its unique identifier. operationId: getDisbursement tags: - disbursements security: - bearerAuth: [] parameters: - name: id in: path description: The unique identifier for the disbursement required: true schema: type: string example: "disbursement_01jpjen1s23s29kkmnjsb6fzga" responses: "200": description: The disbursement was retrieved content: application/json: schema: $ref: "#/components/schemas/Disbursement" "400": $ref: "#/components/responses/BadRequestError" "401": $ref: "#/components/responses/AuthenticationError" "403": $ref: "#/components/responses/ForbiddenError" "404": $ref: "#/components/responses/NotFoundError" "500": $ref: "#/components/responses/InternalServerError" /v1/disbursements/{id}/approve: post: summary: Approve a disbursement description: | Approve a disbursement in a pending_approval state. If the disbursement is in a different state, this will return a 400 error. operationId: approveDisbursement tags: - disbursements security: - bearerAuth: [] parameters: - name: id in: path description: The unique identifier for the disbursement required: true schema: type: string example: "disbursement_01jpjen1s23s29kkmnjsb6fzga" responses: "200": description: The disbursement was approved content: application/json: schema: $ref: "#/components/schemas/Disbursement" "400": $ref: "#/components/responses/BadRequestError" "401": $ref: "#/components/responses/AuthenticationError" "403": $ref: "#/components/responses/ForbiddenError" "404": $ref: "#/components/responses/NotFoundError" "500": $ref: "#/components/responses/InternalServerError" /v1/disbursements/approve: post: summary: Approve multiple disbursements description: | Approve multiple disbursements in a single request. This is useful for batch approval operations. All disbursements must be in the `pending_approval` state. If any disbursement cannot be approved, the entire request will fail and no disbursements will be approved. operationId: bulkApproveDisbursements tags: - disbursements security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object required: - disbursement_ids properties: disbursement_ids: type: array description: Array of disbursement IDs to approve minItems: 1 items: type: string example: "disbursement_01jpjen1s23s29kkmnjsb6fzga" responses: "200": description: The disbursements were approved content: application/json: schema: type: object required: - disbursements - count properties: disbursements: type: array items: $ref: "#/components/schemas/Disbursement" count: type: integer description: The number of disbursements approved example: 5 "400": $ref: "#/components/responses/BadRequestError" "401": $ref: "#/components/responses/AuthenticationError" "403": $ref: "#/components/responses/ForbiddenError" "404": $ref: "#/components/responses/NotFoundError" "500": $ref: "#/components/responses/InternalServerError" /v1/disbursements/{id}/cancel: post: summary: Cancel a pending disbursement description: | Cancel a pending disbursement in a pending_approval state. If the disbursement is in a different state, this will return a 400 error. operationId: cancelDisbursement tags: - disbursements security: - bearerAuth: [] parameters: - name: id in: path description: The unique identifier for the disbursement required: true schema: type: string example: "disbursement_01jpjen1s23s29kkmnjsb6fzga" responses: "200": description: The disbursement was canceled content: application/json: schema: $ref: "#/components/schemas/Disbursement" "400": $ref: "#/components/responses/BadRequestError" "401": $ref: "#/components/responses/AuthenticationError" "403": $ref: "#/components/responses/ForbiddenError" "404": $ref: "#/components/responses/NotFoundError" "500": $ref: "#/components/responses/InternalServerError" /v1/disbursements/{id}/stop: post: summary: Stop payment for a disbursement description: | Stop payment for a disbursement sent via check. This prevents the recipient from depositing the check. If the check has already been deposited, the stop payment request will fail. **Requirements:** - Disbursement must be in `submitted` status - Disbursement must be sent via check - Check must not have already been deposited After successfully stopping payment, the disbursement status will be updated to `stopped`. operationId: stopDisbursement tags: - disbursements security: - bearerAuth: [] parameters: - name: id in: path description: The unique identifier for the disbursement required: true schema: type: string example: "disbursement_01jpjen1s23s29kkmnjsb6fzga" requestBody: $ref: "#/components/requestBodies/StopDisbursementRequest" responses: "202": description: The stop payment request was accepted "400": $ref: "#/components/responses/BadRequestError" "401": $ref: "#/components/responses/AuthenticationError" "403": $ref: "#/components/responses/ForbiddenError" "404": $ref: "#/components/responses/NotFoundError" "412": $ref: "#/components/responses/PreconditionFailedError" "500": $ref: "#/components/responses/InternalServerError" /v1/simulations/disbursements/{id}/complete: post: summary: "Sandbox: Complete a disbursement" description: | Simulates successful disbursement completion for testing purposes. The disbursement must have a status of `submitted`. After calling this endpoint, the disbursement status will be updated to `completed`. This API is only available in the sandbox environment. operationId: simulateDisbursementCompletion tags: - disbursements security: - bearerAuth: [] parameters: - name: id in: path description: The unique identifier for the disbursement required: true schema: type: string example: "disbursement_01jpjen1s23s29kkmnjsb6fzga" responses: "202": description: The disbursement completion request was accepted "400": $ref: "#/components/responses/BadRequestError" "401": $ref: "#/components/responses/AuthenticationError" "403": $ref: "#/components/responses/ForbiddenError" "404": $ref: "#/components/responses/NotFoundError" "500": $ref: "#/components/responses/InternalServerError" /v1/simulations/disbursements/{id}/fail: post: summary: "Sandbox: Fail a disbursement" description: | Simulates a payment failure or return for testing purposes. The disbursement must have a status of `submitted`. This only applies for disbursements sent via ACH or check. - **ACH disbursements**: Status becomes `failed` (payment was returned and cannot be retried) - **Check disbursements**: Status becomes `validating_organization` (check was returned). When this happens, Chariot will investigate why the check failed to reach the organization, update any required recipient information (such as mailing address or organization contact details), and automatically reattempt payout once the issue is resolved. This API is only available in the sandbox environment. operationId: simulateDisbursementFailure tags: - disbursements security: - bearerAuth: [] parameters: - name: id in: path description: The unique identifier for the disbursement required: true schema: type: string example: "disbursement_01jpjen1s23s29kkmnjsb6fzga" responses: "202": description: The disbursement failure simulation was accepted "400": $ref: "#/components/responses/BadRequestError" "401": $ref: "#/components/responses/AuthenticationError" "403": $ref: "#/components/responses/ForbiddenError" "404": $ref: "#/components/responses/NotFoundError" "500": $ref: "#/components/responses/InternalServerError" /v1/inbound_transfers: post: summary: Create an Inbound transfer description: |- Create an inbound transfer to fund your financial account from an externally linked bank account. In Production, this requires that an external bank account has been setup and verified for your account through the Chariot Dashboard. operationId: createInboundTransfer tags: - inboundTransfers security: - bearerAuth: [] parameters: - name: Idempotency-Key in: header description: The idempotency key for the request required: false schema: type: string requestBody: $ref: "#/components/requestBodies/CreateInboundTransferRequest" responses: "201": description: The inbound transfer was created headers: Location: $ref: "#/components/headers/Location" Idempotency-Key: $ref: "#/components/headers/Idempotency-Key" content: application/json: schema: $ref: "#/components/schemas/InboundTransfer" "400": $ref: "#/components/responses/BadRequestError" "401": $ref: "#/components/responses/AuthenticationError" "403": $ref: "#/components/responses/ForbiddenError" "409": $ref: "#/components/responses/ConflictError" "500": $ref: "#/components/responses/InternalServerError" get: summary: List Inbound Transfers description: |- List inbound transfers for your account. operationId: listInboundTransfers tags: - inboundTransfers security: - bearerAuth: [] parameters: - name: limit in: query description: Limit the size of the list that is returned. The default (and maximum) is 100 objects. required: false schema: type: integer format: int32 - name: pageToken in: query description: The cursor to use for pagination. If not set, the first page of results will be returned. required: false schema: type: string responses: "200": $ref: "#/components/responses/ListInboundTransfersResponse" "400": $ref: "#/components/responses/BadRequestError" "401": $ref: "#/components/responses/AuthenticationError" "403": $ref: "#/components/responses/ForbiddenError" "404": $ref: "#/components/responses/NotFoundError" "500": $ref: "#/components/responses/InternalServerError" /v1/inbound_transfers/{id}: get: summary: Get an Inbound Transfer description: |- Get an inbound transfer by its unique identifier. operationId: getInboundTransfer tags: - inboundTransfers security: - bearerAuth: [] parameters: - name: id in: path description: The unique identifier for the inbound transfer required: true schema: type: string example: "inbound_transfer_01j8rs605a4gctmbm58d87mvsj" responses: "200": description: The inbound transfer was retrieved content: application/json: schema: $ref: "#/components/schemas/InboundTransfer" "400": $ref: "#/components/responses/BadRequestError" "401": $ref: "#/components/responses/AuthenticationError" "403": $ref: "#/components/responses/ForbiddenError" "404": $ref: "#/components/responses/NotFoundError" "500": $ref: "#/components/responses/InternalServerError" /v1/inbound_transfers/{id}/cancel: post: summary: Cancel an Inbound Transfer description: |- Cancel an inbound transfer. Returns the Inbound Transfer object if the cancelation succeeded. Returns a 412 Precondition Failed if the Inbound Transfer has already been canceled or cannot be canceled. operationId: cancelInboundTransfer tags: - inboundTransfers security: - bearerAuth: [] parameters: - name: id in: path description: The unique identifier for the inbound transfer required: true schema: type: string example: "inbound_transfer_01j8rs605a4gctmbm58d87mvsj" responses: "200": description: The inbound transfer was canceled content: application/json: schema: $ref: "#/components/schemas/InboundTransfer" "400": $ref: "#/components/responses/BadRequestError" "401": $ref: "#/components/responses/AuthenticationError" "403": $ref: "#/components/responses/ForbiddenError" "404": $ref: "#/components/responses/NotFoundError" "409": $ref: "#/components/responses/ConflictError" "412": $ref: "#/components/responses/PreconditionFailedError" "500": $ref: "#/components/responses/InternalServerError" /v1/simulations/inbound_transfers/{id}/fail: post: summary: "Sandbox: Fail an Inbound Transfer" description: |- Simulate an inbound transfer failure. This API is only available in the sandbox environment. operationId: simulateInboundTransferFailure tags: - inboundTransfers security: - bearerAuth: [] parameters: - name: id in: path description: The unique identifier for the inbound transfer required: true schema: type: string example: "inbound_transfer_01j8rs605a4gctmbm58d87mvsj" responses: "202": description: The inbound transfer failure request was accepted "400": $ref: "#/components/responses/BadRequestError" "401": $ref: "#/components/responses/AuthenticationError" "403": $ref: "#/components/responses/ForbiddenError" "404": $ref: "#/components/responses/NotFoundError" "500": $ref: "#/components/responses/InternalServerError" /v1/simulations/inbound_transfers/{id}/complete: post: summary: "Sandbox: Complete an Inbound Transfer" description: |- Simulate an inbound transfer completion. This API is only available in the sandbox environment. operationId: simulateInboundTransferCompletion tags: - inboundTransfers security: - bearerAuth: [] parameters: - name: id in: path description: The unique identifier for the inbound transfer required: true schema: type: string example: "inbound_transfer_01j8rs605a4gctmbm58d87mvsj" responses: "202": description: The inbound transfer completion request was accepted "400": $ref: "#/components/responses/BadRequestError" "401": $ref: "#/components/responses/AuthenticationError" "403": $ref: "#/components/responses/ForbiddenError" "404": $ref: "#/components/responses/NotFoundError" "500": $ref: "#/components/responses/InternalServerError" components: securitySchemes: bearerAuth: type: http scheme: bearer schemas: CreateDisbursementInput: type: object description: |- The request to create a disbursement and its corresponding transactions. The organization and amount are required. The transactions array should contain the list of transactions associated with the disbursement. The amounts in the transactions should sum up to the disbursement amount. required: - organization_id - amount - transactions properties: organization_id: type: string description: The ID of the organization that will receive the disbursement. example: "org_1234567890" program_id: type: string description: |- The identifier for the program that the disbursement is associated with. The program must have grant_disbursement_status enabled. If not provided, your grant_disbursement_status enabled program will be used. If your Chariot account has multiple grant_disbursement_status enabled programs, you must specify the program_id to use for the disbursement. example: "program_01jpjenf5q6cawy43yxfcrxhct" nullable: true amount: type: integer format: int64 description: The disbursement amount in USD cents. Must be a positive amount. example: 10000 auto_fund: type: boolean description: |- Enable just-in-time (JIT) funding for this disbursement. When true, Chariot will automatically create an inbound transfer for the disbursement amount when it is approved, eliminating the need to pre-fund your account. This feature must be enabled on your account. Contact Chariot to enable JIT disbursements. example: false default: false transactions: type: array description: |- The list of transactions associated with the disbursement. Each transaction is an individual donation to be included in the disbursement. Must specify at least one transaction. The sum of all transaction net amounts (amount - fee_amount) must equal the disbursement amount. items: type: object description: | An individual donation to be included in the disbursement. required: - amount - type properties: amount: type: integer format: int64 description: | The gross transaction amount in minor currency units (cents) before any fees are deducted. This represents the total amount of the donation. example: 10000 fee_amount: type: integer format: int64 description: | Optional fee amount in minor currency units (cents) to be deducted from the transaction. If provided, the fee amount must be less than the transaction amount. The net amount (amount - fee_amount) will be used when calculating the disbursement total. example: 500 nullable: true description: type: string description: | A description of the donation. This description is displayed to the receiving organization. example: "Donation to nonprofit" type: $ref: "#/components/schemas/DonationType" donor_advised_fund_grant: $ref: "#/components/schemas/DonorAdvisedFundGrant" metadata: type: object description: Additional metadata for the transaction additionalProperties: type: string OrganizationSummary: type: object description: |- A summary of an organization. required: - id - ein - name properties: id: type: string description: The unique identifier for the organization. example: org_01j8rs605a4gctmbm58d87mvsj ein: type: string description: The Employer Identification Number (EIN) or TaxID for the nonprofit entity. example: "123456789" name: type: string description: The name of the organization. example: American Red Cross daf_eligible: type: boolean description: Whether the organization is eligible to receive donations from a Donor Advised Fund. example: true city: type: string description: The city of the organization. example: New York state: type: string description: The state of the organization. example: NY Organization: type: object description: |- An `Organization` represents an operating nonprofit or an operating sub-organization of a parent or sponsoring nonprofit. The generally accepted identifier for an organization is its domain. This domain provides proof of identity, ownership and relationship to an entity. Organizations can receive payments from payers on the network. required: - id - ein - name properties: id: type: string readOnly: true description: The unique identifier for the object. example: org_01j8rs605a4gctmbm58d87mvsj ein: type: string description: The EIN of the organization. example: "123456789" name: type: string description: |- The name of the organization. For organizations that operate under a different name than the one tied to the legal entity, this name will differ from the name of the linked entity. This is also known as the "DBA" or "Doing Business As" name of the organization. example: American Red Cross parent_organization_id: type: string description: |- The unique identifier of the parent organization, if this is a sponsored organization. This value is `null` or empty if the organization is not sponsored or not a child of a parent organization. example: org_01j8rs605a4gctmbm58d87mvsk physical_address: $ref: "#/components/schemas/Address" classification: $ref: "#/components/schemas/NonprofitClassification" compliance: $ref: "#/components/schemas/NonprofitCompliance" mission_statement: type: string description: The mission statement of the organization example: To provide relief to those in need web: $ref: "#/components/schemas/WebDomain" brand: $ref: "#/components/schemas/Brand" officers: type: array description: The list of officers of the organization items: $ref: "#/components/schemas/Person" claimed: type: boolean readOnly: true description: |- A flag to indicate if the nonprofit has been claimed by a user. A nonprofit is claimed if a user signs up for a Chariot account with this nonprofit and is verified by the Chariot team. NonprofitClassification: type: object description: |- A classification of the nonprofit entity as defined by the IRS. properties: group_exemption_number: type: string description: This is a four-digit internal IRS number assigned to central/parent entity holding group exemption letters. subsection_code: $ref: "#/components/schemas/TaxExemptCode" filing_requirement_code: $ref: "#/components/schemas/TaxExemptCode" foundation_code: $ref: "#/components/schemas/TaxExemptCode" affiliation_code: $ref: "#/components/schemas/TaxExemptCode" organization_code: $ref: "#/components/schemas/TaxExemptCode" exempt_status_code: $ref: "#/components/schemas/TaxExemptCode" deductibility_code: $ref: "#/components/schemas/TaxExemptCode" ntee_code: $ref: "#/components/schemas/NteeCode" naics_code: $ref: "#/components/schemas/NaicsCode" NonprofitCompliance: type: object description: |- An object that contains legal information about the nonprofit entity and its tax-exemption status. This information is used to comply with regulations and ensure the legitimacy of the nonprofit for purposes of donations and disbursements. properties: daf_eligible: type: boolean description: Whether the entity is eligible to receive donations from a Donor Advised Fund example: true irs_pub_78: $ref: "#/components/schemas/ComplianceRequirement" ofac: $ref: "#/components/schemas/ComplianceRequirement" foundation_code: $ref: "#/components/schemas/ComplianceRequirement" california_attorney_general_registry: $ref: "#/components/schemas/ComplianceRequirement" california_franchise_tax_board: $ref: "#/components/schemas/ComplianceRequirement" Person: type: object description: |- A person is an individual who is an officer of a nonprofit. required: - name properties: name: type: string description: The full name of the person title: type: string description: The title or role of the person with respect to the nonprofit entity example: Executive Director TaxExemptCode: type: object description: |- A tax exempt code is a code that is used to classify the tax-exempt status of a nonprofit entity. required: - name - code properties: code: type: integer description: The code of the tax exempt code example: 1 name: type: string description: The name of the tax exempt code example: "UNCONDITIONAL" description: type: string description: The description of the tax exempt code example: "Unconditional Exemption" NteeCode: type: object description: |- A code that is used to classify the nonprofit entity as defined by the IRS. required: - code - description properties: code: type: string description: The code of the NTEE code example: "A" description: type: string description: The description of the NTEE code example: "Animal Welfare" parent_code: type: string description: The parent code of the NTEE code example: "A" parent_description: type: string description: The description of the parent NTEE code example: "Animal Welfare" NaicsCode: type: object description: |- A code that is used to classify the nonprofit entity as defined by the NAICS. properties: naics2: type: string description: The code of the NAICS code example: "31" naics2_description: type: string description: The description of the NAICS code example: "Manufacturing" naics4: type: string description: The code of the NAICS code example: "3112" naics4_description: type: string description: The description of the NAICS code example: "Grain and Oilseed Milling" naics6: type: string description: The code of the NAICS code example: "311221" naics6_description: type: string description: The description of the NAICS code example: "Wet Corn Milling and Starch Manufacturing" ComplianceRequirement: type: object description: |- A compliance requirement is a requirement that a nonprofit entity must meet in order to be eligible for Chariot services. properties: compliant: type: boolean description: Whether the entity is compliant with the requirement example: true reason: type: string description: The reason for the compliance requirement last_found_at: type: string format: date-time description: The date and time when the compliance requirement was last found example: "2020-01-31T23:00:00Z" WebDomain: type: object description: |- 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 underpin the web and online interactions. The domain can be used as an identifier and its validity can be asserted via DNS. required: - domain properties: domain: type: string description: The DNS domain name example: "redcross.org" Brand: type: object description: |- Fair use brand assets that are associated with an organization and can be used for identification and informational purposes. properties: icon_url: type: string description: The URL of the organization's icon logo_url: type: string description: The URL of the organization's logo Connect: type: object description: |- A Connect represents an instance of Chariot Connect for a particular nonprofit. A nonprofit organization will create Connect objects in order to integrate Chariot Connect into their websites or fundraising platforms to start accepting donations directly from Donor Advised Funds. Each nonprofit can have multiple Connect objects where each one represents a logical separation for how the organization wants to organize their sources of donations. For example, they might have 2 Connect instances, one that they use to integrate Chariot Connect directly on their website and the other that they provide to a 3rd party fundraising platform. On the client side, Chariot Connect is instantiated with the `id` of the Connect object, also called the `cid`. A connect object also contains an `apiKey`. This is useful for nonprofits to provide to fundraising platforms on their behalf to programatically integrate Chariot Connect and access resources and information created from the Connect instance through various Chariot API endpoints. More information on integrating Chariot Connect into a client-side application can be found here: https://givechariot.readme.io required: - id - apiKey properties: id: type: string readOnly: true description: |- The unique identifier for this object. This is also the 'publishable' cid to use for initializing Connect for client-side integration. example: test_connect123 name: type: string description: A human readable name for the connect, optional. example: website apiKey: type: string readOnly: true description: (deprecated) A secure token that can be used to make M2M API calls to read data generated by this object. example: test_apiTokenABC active: type: boolean description: |- A flag to indicate if this connect is active. If true, then this Connect can process donations and grants, otherwise this Connect cannot process grants. example: true createdAt: type: string readOnly: true format: date-time description: Time when this object was created. Expressed in RFC 3339 format. example: "2020-01-31T23:00:00Z" updatedAt: type: string readOnly: true format: date-time description: Time when this object was last updated. Expressed in RFC 3339 format. example: "2020-01-31T23:59:59Z" createdBy: type: string readOnly: true description: ID of the user who created this object. example: auth0-user-id-123 archived: type: boolean readOnly: true description: A flag to indicate if this object is marked for deletion. example: false metadata: type: object description: A map of arbitrary string keys and values to store information about the object. additionalProperties: type: string Daf: type: object description: |- A Donor-Advised Fund, or `DAF` for short, is a special-purpose, tax-advantaged charitable account. For more information, please see the [IRS website](https://www.irs.gov/charities-non-profits/charitable-organizations/donor-advised-funds) for a full description. In the case that a DAF is supported, a donor will be able to initiate a grant directly through DAFpay. required: - id - orgName - address - address2 - city - state - zip - supported - minimumGrantAmount - institutionDown properties: id: type: string readOnly: true description: The unique identifier for this object. example: 0bf40881-8ee2-47fb-98ca-f58c7999aa34 orgName: type: string readOnly: true description: A human readable name for the DAF. example: website address: type: string readOnly: true description: The first address line. example: 123 Main St. address2: type: string readOnly: true description: The second address line. example: Apt 100 city: type: string readOnly: true description: The city name for the address. example: New York City state: type: string readOnly: true description: The state name for the address. example: New York zip: type: string readOnly: true description: The zipcode for the address. example: "12345" supported: type: boolean readOnly: true description: A flag to indicate if this DAF is supported by DAFpay. example: false minimumGrantAmount: type: number readOnly: true description: The minimum grant amount in cents allowed for this DAF. example: 5000 institutionDown: type: boolean readOnly: true description: A flag to indicate if the institution is down. example: false Grant: type: object description: |- A Grant represents a successfully initiated grant request with a Donor Advised Fund. Grants are created when a person interacts with an instance of Chariot Connect and successfully submits a grant and completes the workflow. There can be many grants associated with a Connect object and therefore a nonprofit. required: - id - workflowSessionId - fundId - amount properties: id: type: string readOnly: true description: The unique identifier for the object format: uuid example: cfe09e64-6a74-4dab-a565-361185a6f248 userFriendlyId: type: string readOnly: true description: Often referred to as the "Chariot ID", this is the ID that will be included in the payment from the DAF provider. example: chariot-1234455 deprecated: true trackingId: type: string readOnly: true description: The tracking ID for the grant example: L9E182VBGP workflowSessionId: type: string readOnly: true description: ID of the Connect Workflow Session associated with this grant format: uuid example: 2d4b2a43-a5b4-4be1-ad1f-f932016ca4a6 fundId: type: string readOnly: true description: ID of the donor advised fund example: daf-id externalGrantId: type: string description: ID of the grant associated with the donor advised fund example: 897823sdjf8sfjs createdAt: type: string readOnly: true format: date-time description: Time when this object was created; expressed in RFC 3339 format example: "2020-01-31T23:00:00Z" updatedAt: type: string readOnly: true format: date-time description: Time when this object was last updated; expressed in RFC 3339 format example: "2020-01-31T23:59:59Z" amount: type: number format: integer description: The grant amount expressed in units of whole cents example: 15000 status: type: string description: The status of the grant example: Initiated feeDetail: type: object readOnly: true description: The fee detail of the grant properties: total: type: number format: integer description: The total fee amount expressed in units of cents example: 1500 contributions: type: array items: $ref: "#/components/schemas/ContributionFeeDetail" description: The list of fee contributions for this grant metadata: type: object description: A map of arbitrary string keys and values to store information about the object additionalProperties: type: string firstName: type: string description: The donor's first name example: "Warren" lastName: type: string description: The donor's last name example: "Buffet" phone: type: string description: The donor's phone number example: "1237861020" email: type: string description: The donor's email example: "warrenBuffet@example.com" note: type: string description: An note inputted by the user at submisson example: "Please dedicate in memory of grandma" statuses: type: array items: $ref: "#/components/schemas/GrantStatus" description: The list of grant statuses for this grant paymentChannel: type: string readOnly: true description: |- The payment channel for the grant. This is useful to know how the grant will be sent. The payment channel will be one of the following: - dafpay_network: Grant will be sent to the DAFPay Network 501(c)(3) nonprofit organization (EIN: 93-1372175). The DAFPay Network will then review and process the grant and send the funds to the intended recipient. - direct: Grant will be sent directly to the intended recipient. enum: - dafpay_network - direct example: direct address: $ref: "#/components/schemas/GrantAddress" RecurringGrant: type: object description: |- A RecurringGrant represents a successfully initiated recurring grant request with a Donor Advised Fund. RecurringGrants are created when a person interacts with an instance of Chariot Connect and successfully submits a recurring grant and completes the workflow. On creation, each RecurringGrant object will also have a Grant object created to represent the first grant of the recurring grant. There can be many grants associated with the same recurring grant. required: - id - workflowSessionId - fundId - amount - frequency properties: id: type: string readOnly: true description: The unique identifier for the object format: uuid example: cfe09e64-6a74-4dab-a565-361185a6f248 trackingId: type: string readOnly: true description: The tracking ID for the grant example: L9E182VBGP workflowSessionId: type: string readOnly: true description: ID of the Connect Workflow Session associated with this grant format: uuid example: 2d4b2a43-a5b4-4be1-ad1f-f932016ca4a6 fundId: type: string readOnly: true description: ID of the donor advised fund example: daf-id frequency: type: string description: |- How often the DAF provider will submit the recurring grant. At the moment, monthly is the only supported frequency. enum: - MONTHLY example: MONTHLY externalRecurringGrantId: type: string description: ID of the grant associated with the donor advised fund example: 897823sdjf8sfjs createdAt: type: string readOnly: true format: date-time description: Time when this object was created; expressed in RFC 3339 format example: "2020-01-31T23:00:00Z" updatedAt: type: string readOnly: true format: date-time description: Time when this object was last updated; expressed in RFC 3339 format example: "2020-01-31T23:59:59Z" amount: type: number format: integer description: The grant amount expressed in units of whole cents example: 15000 firstName: type: string description: The donor's first name example: "Warren" lastName: type: string description: The donor's last name example: "Buffet" phone: type: string description: The donor's phone number example: "1237861020" email: type: string description: The donor's email example: "warrenBuffet@example.com" note: type: string description: An note inputted by the user at submisson example: "Please dedicate in memory of grandma" address: $ref: "#/components/schemas/GrantAddress" ContributionFeeDetail: type: object required: - name - amount properties: name: type: string description: | The name of the party charging the fee. This is an informational field. If you need to differentiate between fees charged by different parties, you should use the `feeType` field. example: "Chariot" amount: type: number format: integer description: The fee contribution amount expressed in units of cents example: 1500 feeType: type: string description: | This indicates the source of a fee contribution. * chariot: Chariot's processing fee * daf: The DAF's processing fee * fundraising_application: The fundraising application's processing fee example: "chariot" enum: - chariot - daf - fundraising_application GrantStatus: type: object required: - id - createdAt - status properties: id: type: string readOnly: true description: The unique identifier for the object format: uuid example: cfe09e64-6a74-4dab-a565-361185a6f248 createdAt: type: string readOnly: true format: date-time description: Time when this object was created; expressed in RFC 3339 format example: "2020-01-31T23:00:00Z" status: type: string enum: - Initiated - Completed - Canceled description: | The status of the grant. example: Initiated comment: type: string description: The user comment for the update example: The grant has been received by the nonprofit UnintegratedGrant: type: object description: |- An Unintegrated Grant represents a grant requested through a provider that Chariot does not support. Unintegrated grants should be treated as donation intents as Chariot can not guarantee that the grant was submitted or will be fulfilled. Nonprofits should use the information provided in the unintegrated grant to follow up with the donor and/or the provider to check the status of the grant. These are sometimes referred to as "Manual Grants". required: - id - workflowSessionId - fundId - amount properties: id: type: string readOnly: true description: The unique identifier for the object format: uuid example: cfe09e64-6a74-4dab-a565-361185a6f248 userFriendlyId: type: string readOnly: true description: Often referred to as the "Chariot ID", this is the ID that will be included in the payment from the DAF provider. example: "1234455" deprecated: true trackingId: type: string readOnly: true description: The tracking ID for the unintegrated grant example: L9E182VBGP workflowSessionId: type: string readOnly: true description: ID of the Connect Workflow Session associated with this grant format: uuid example: 2d4b2a43-a5b4-4be1-ad1f-f932016ca4a6 fundId: type: string readOnly: true description: ID of the donor advised fund example: daf-id createdAt: type: string readOnly: true format: date-time description: Time when this object was created; expressed in RFC 3339 format example: "2020-01-31T23:00:00Z" updatedAt: type: string readOnly: true format: date-time description: Time when this object was last updated; expressed in RFC 3339 format example: "2020-01-31T23:59:59Z" amount: type: number format: integer description: The grant amount expressed in units of whole cents example: 15000 status: type: string description: |- The status of the unintegrated grant. enum: - Unknown - Completed - Canceled example: Unknown metadata: type: object description: A map of arbitrary string keys and values to store information about the object additionalProperties: type: string firstName: type: string description: The donor's first name example: "Warren" lastName: type: string description: The donor's last name example: "Buffet" phone: type: string description: The donor's phone number example: "1237861020" email: type: string description: The donor's email example: "warrenBuffet@example.com" address: $ref: "#/components/schemas/GrantAddress" note: type: string description: An note inputted by the user at submisson example: "Please dedicate in memory of grandma" paymentChannel: type: string readOnly: true description: |- The payment channel for the unintegrated grant. This is useful to know how the grant will be sent. The payment channel for unintegrated grants will always be: - offline: Grant was initiated outside of Chariot so we're unable to confirm how the grant will be sent. enum: - offline example: offline FinancialAccount: type: object description: |- A financial account represents a financial, depository (bank) account managed by Chariot. Chariot maintains a ledger and balances for the account. This account should be funded and have a sufficient available balance before disbursements can be created. Chariot is a financial technology company, not a bank. Chariot Deposit Accounts come through our banking services partner, Column, N.A. required: - id - name - program_id - bank_provider - created_at - updated_at properties: id: type: string description: The unique identifier for the account example: "account_01jpjenf5q6cawy43yxfcrxhct" account_type: type: string deprecated: true description: |- The type of account. This field is deprecated and will be removed in a future version. Use the program_id field instead. enum: - disbursements - processing example: "disbursements" program_id: type: string description: The identifier for the program determining the capabilities of this financial account example: "program_01jpjenf5q6cawy43yxfcrxhct" readOnly: true bank_provider: type: string description: The bank provider for the account example: "mock_alpha" readOnly: true created_at: type: string format: date-time description: The date and time the account was created example: "2020-01-31T23:00:00Z" updated_at: type: string format: date-time description: The date and time the account was last updated example: "2020-01-31T23:00:00Z" FinancialAccountBalance: type: object required: - current_balance - available_balance - timestamp properties: current_balance: type: number description: The current balance is the amount of money in the account. This value is in minor currency units (USD cents). example: 10000 available_balance: type: number description: The available balance is the amount of money in the account that is available to be spent or transferred. This value is in minor currency units (USD cents). example: 10000 timestamp: type: string format: date-time description: The time the balance was retrieved example: "2020-01-31T23:00:00Z" Address: type: object properties: city: type: string description: "City, district, suburb, town, or village. Maximum length: 255 characters." country: type: string description: "Two-letter country code (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). Maximum length: 255 characters." line1: type: string description: "Address line 1 (e.g. street, PO Box, or company name). Maximum length: 255 characters." line2: type: string description: "Address line 2 (e.g. apartment, suite, unit, or building). Maximum length: 255 characters." postal_code: type: string description: "ZIP or postal code. Maximum length: 40 characters." state: type: string description: "State, county, province, or region. Maximum length: 255 characters." GrantAddress: type: object properties: line1: type: string description: "Address line 1 (e.g. street, PO Box, or company name). Maximum length: 255 characters." line2: type: string description: "Address line 2 (e.g. apartment, suite, unit, or building). Maximum length: 255 characters." city: type: string description: "City, district, suburb, town, or village.. Maximum length: 255 characters." state: type: string description: "State, county, province, or region. Maximum length: 255 characters." postalCode: type: string description: "ZIP or postal code. Maximum length: 255 characters." PostalAddress: type: object description: |- A postal address is a mailing address where physical mail can be received. Postal addresses can be used to receive paper checks. required: - city - country - line1 - postal_code - state properties: city: type: string description: City, district, suburb, town, or village. country: type: string description: Two-letter country code (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) line1: type: string description: Address line 1 (e.g. street, PO Box, or company name) line2: type: string description: Address line 2 (e.g. apartment, suite, unit, or building) postal_code: type: string description: ZIP or postal code state: type: string description: State, county, province, or region Disbursement: type: object description: A disbursement moves funds to a verified organization. required: - id - organization_id - program_id - amount properties: id: type: string description: The unique identifier for the disbursement example: "disbursement_01jpjen1s23s29kkmnjsb6fzga" readOnly: true organization_id: type: string description: The unique identifier for the organization that will receive the payment example: "org_01jpjenf5q6cawy43yxfcrxhct" organization: $ref: "#/components/schemas/Organization" program_id: type: string description: The identifier for the program that the disbursement is associated with example: "program_01jpjenf5q6cawy43yxfcrxhct" readOnly: true amount: type: integer format: int64 description: The payment amount in USD cents. Must be a positive amount. example: 10000 auto_fund: type: boolean description: |- Whether just-in-time (JIT) funding is enabled for this disbursement. When true, Chariot automatically creates an inbound transfer for the disbursement amount when it is approved. example: false readOnly: true created_at: type: string format: date-time description: The date and time the disbursement was created example: "2020-01-31T23:00:00Z" readOnly: true updated_at: type: string format: date-time description: The date and time the disbursement was last updated example: "2020-01-31T23:00:00Z" readOnly: true status: $ref: "#/components/schemas/DisbursementStatus" cancelation: $ref: "#/components/schemas/DisbursementCancelation" approval: $ref: "#/components/schemas/DisbursementApproval" rejection: $ref: "#/components/schemas/DisbursementRejection" transfers: type: array description: |- The list of transfers for the disbursement. This can have multiple items if the disbursement's underlying payment was retried multiple times. For example, if a check was returned or stopped and the disbursement was retried as an ACH transfer. If the disbursement was not retried, this will have a single item. items: $ref: "#/components/schemas/DisbursementTransfer" transactions: type: array description: The list of transactions for the disbursement items: $ref: "#/components/schemas/Transaction" DisbursementStatus: type: string description: |- The lifecycle status of the disbursement. Possible values include: - `pending_approval`: The disbursement is awaiting approval from the grantmaker - `canceled`: The disbursement was canceled by the grantmaker - `awaiting_verification`: The disbursement is awaiting verification from Chariot - `rejected`: The disbursement was rejected by Chariot before being submitted - `validating_organization`: Validating recipient organization's payment and contact information before submission. - `awaiting_account_claim`: The disbursement is awaiting account claim by the nonprofit or check delay expiration - `awaiting_balance`: The disbursement is awaiting sufficient grantmaker balance - `submitted`: The disbursement payment has been submitted to the payment network and is being processed - `stopped`: The disbursement payment was stopped after it was submitted - `completed`: The disbursement payment has been completed and funds have been received by the receiving organization - `failed`: The disbursement payment failed or the receiving organization did not receive the payment To see a description of each status, see the "Disbursement Lifecycle" section of the Chariot documentation. example: "pending_approval" enum: - pending_approval - canceled - awaiting_verification - rejected - validating_organization - awaiting_account_claim - awaiting_balance - submitted - stopped - completed - failed DisbursementCancelation: type: object description: |- If your account requires approvals for disbursements and the disbursement was not approved, this will contain the details of the cancelation. properties: canceled_by: type: string description: If the disbursement was canceled by a user in the dashboard, the email address of that user. example: "user@example.com" canceled_at: type: string format: date-time description: The RFC 3339 date and time at which the Disbursement was canceled. example: "2020-01-31T23:00:00Z" readOnly: true DisbursementApproval: type: object description: |- If your account requires approvals for disbursements and the disbursement was approved, this will contain the details of the approval. properties: approved_by: type: string description: If the disbursement was approved by a user in the dashboard, the email address of that user. example: "user@example.com" approved_at: type: string format: date-time description: The RFC 3339 date and time at which the Disbursement was approved. example: "2020-01-31T23:00:00Z" readOnly: true DisbursementRejection: type: object description: |- If the disbursement was rejected by Chariot, this will contain details as to why the disbursement was rejected. properties: reason: type: string description: |- Why the disbursement was rejected. Possible values include: - `insufficient_funds`: The disbursement was rejected because the grantmaker does not have enough funds in their account. - `incorrect_recipient`: The disbursement was rejected because the recipient or address was incorrect. - `suspected_fraud`: The disbursement was suspected to be fraudulent. - `requested_by_user`: The disbursement was rejected at the request of the grantmaker. - `acceptance_criteria_failed`: The disbursement was rejected because the disbursement did not meet the acceptance criteria for the receiving organization. - `duplicate`: The disbursement was rejected because the disbursement was a duplicate. - `unknown`: The disbursement was rejected for an unknown reason. example: "insufficient_funds" enum: - insufficient_funds - incorrect_recipient - suspected_fraud - requested_by_user - acceptance_criteria_failed - duplicate - unknown rejected_at: type: string format: date-time description: The RFC 3339 date and time at which the Disbursement was rejected. example: "2020-01-31T23:00:00Z" readOnly: true DisbursementTransfer: type: object description: |- 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 specific payment rails/networks. An account transfer is the preferred transfer method when the receiving organization has a Chariot account at the same bank as the grantmaker. An ACH transfer is used when the receiving organization has a Chariot account at a different bank than the grantmaker. A check transfer is used when the receiving organization does not have a Chariot account. properties: account_transfer: $ref: "#/components/schemas/AccountTransfer" ach_transfer: $ref: "#/components/schemas/AchTransfer" check_transfer: $ref: "#/components/schemas/CheckTransfer" AccountTransfer: type: object description: |- An account transfer represents an instant, electronic transfer of funds. required: - id - amount - created_at properties: id: type: string description: The unique identifier for the account transfer example: "account_transfer_01j8rs605a4gctmbm58d87mvsj" readOnly: true amount: type: integer format: int64 description: The amount of the account transfer in minor currency units (cents) example: 10000 created_at: type: string format: date-time description: The date and time the account transfer was created example: "2020-01-31T23:00:00Z" readOnly: true AchTransfer: type: object description: |- An ACH transfer represents an electronic transfer of funds via the Automated Clearing House (ACH) payment network. required: - id - amount - status - created_at properties: id: type: string description: The unique identifier for the ACH transfer example: "ach_transfer_01j8rs605a4gctmbm58d87mvsj" readOnly: true amount: type: integer format: int64 description: |- The amount of the ACH transfer in minor currency units (cents). For ACH debits, this is a negative number. example: 10000 status: type: string description: |- The lifecycle status of the ACH transfer. Possible values include: - `initiated`: The ACH transfer has been initiated and is pending submission to the Federal Reserve. - `submitted`: The ACH transfer has been submitted to the Federal Reserve. - `completed`: The ACH transfer has been completed. Funds should be settled. - `rejected`: The ACH transfer was rejected. - `returned`: The ACH transfer was returned by the receiving organization. example: "initiated" enum: - initiated - submitted - completed - rejected - returned company_entry_description: type: string description: |- The company entry description for the ACH transfer. This is included in the transfer data sent to the receiving bank. example: "Disbursement to nonprofit" trace_number: type: string description: |- A 15 digit number recorded in the Nacha file and transmitted to the receiving bank. Along with the amount, date, and originating routing number, this can be used to identify the ACH transfer at the receiving bank. ACH trace numbers are not unique, but are used to correlate returns. example: "012345678901234" effective_date: type: string format: date-time description: |- The ACH transfer's effective date as sent to the Federal Reserve. This is the date the funds will be available to the receiving organization. example: "2020-01-31T23:00:00Z" submitted_at: type: string format: date-time description: |- The date and time the ACH transfer was submitted to the Federal Reserve. example: "2020-01-31T23:00:00Z" settled_at: type: string format: date-time description: |- The date and time at which the ACH transfer was settled. If the transfer is not settled, this will be null. example: "2020-07-12 15:00:00.000" rejected_at: type: string format: date-time description: |- The date and time at which the ACH transfer was rejected. If the transfer is not rejected, this will be null. example: "2020-07-12 15:00:00.000" returned_at: type: string format: date-time description: |- The date and time at which the ACH transfer was returned. If the transfer is not returned, this will be null. example: "2020-07-12 15:00:00.000" created_at: type: string format: date-time description: The date and time the ACH transfer was created example: "2020-01-31T23:00:00Z" readOnly: true updated_at: type: string format: date-time description: The date and time the ACH transfer was last updated example: "2020-01-31T23:00:00Z" readOnly: true CheckTransfer: type: object description: |- A check transfer represents a paper check that is mailed to the receiving organization. required: - id - amount - status - mailing_address - memo - created_at properties: id: type: string description: The unique identifier for the check transfer example: "check_transfer_01j8rs605a4gctmbm58d87mvsj" readOnly: true amount: type: integer format: int64 description: The amount of the check transfer in minor currency units (cents) example: 10000 status: type: string description: |- The lifecycle status of the check. The set of statuses include: - `pending`: The check is pending review by Chariot. - `canceled`: The check has been canceled. - `issued`: The check has been mailed and is pending delivery. - `rejected`: The check was rejected by Chariot. - `deposited`: The check has been deposited by the receiving organization. - `stopped`: A stop payment was requested on the check. - `returned`: The check has been returned by the receiving organization. To see a more detailed description of each status and the overall lifecycle of check disbursements, see the "Transfer Statuses" section of the Chariot documentation. example: "issued" enum: - pending - canceled - issued - rejected - deposited - stopped - returned memo: type: string description: The memo on the check. Maximum of 72 characters. example: "Disbursement to nonprofit" check_number: type: string description: The check number example: "123456789" recipient_name: type: string description: The name that will be printed on the check. example: "Charity Good" mailing_address: $ref: "#/components/schemas/PostalAddress" tracking_updates: type: array description: The list of tracking updates for the check items: $ref: "#/components/schemas/TrackingUpdate" submitted_at: type: string format: date-time description: The date and time the check was submitted to the carrier. example: "2020-01-31T23:00:00Z" canceled_at: type: string format: date-time description: The date and time the check was canceled. example: "2020-01-31T23:00:00Z" stopped_at: type: string format: date-time description: The date and time the check was stopped. example: "2020-01-31T23:00:00Z" deposited_at: type: string format: date-time description: The date and time the check was deposited. example: "2020-01-31T23:00:00Z" created_at: type: string format: date-time description: The date and time the check transfer was created example: "2020-01-31T23:00:00Z" updated_at: type: string format: date-time description: The date and time the check transfer was last updated example: "2020-01-31T23:00:00Z" TrackingUpdate: type: object description: The tracking update for the check required: - category - created_at properties: category: type: string description: |- The category of the tracking update. The set of categories include: - `in_transit`: The check has been processed by the origin facility. - `processed_for_delivery`: The check has been greenlit for delivery at the recipient's nearest postal facility. The check should reach the mailbox within 1-2 business days of this tracking update. - `delivered`: The check has been delivered to the recipient's address. - `returned_to_sender`: The check has been returned to the sender due to barcode, ID tag area, or address errors. example: "in_transit" enum: - in_transit - processed_for_delivery - delivered - returned_to_sender created_at: type: string format: date-time description: The date and time the tracking update was created example: "2020-01-31T23:00:00Z" StopDisbursementPaymentReason: type: string description: |- The reason for stopping a disbursement payment. Possible values include: - `mail_delivery_failure`: The check could not be delivered. - `not_authorized`: The check was not authorized. - `voided`: The check was stopped and voided. - `unknown`: The reason for stopping the disbursement payment is unknown. example: "mail_delivery_failure" enum: - mail_delivery_failure - not_authorized - voided - unknown InboundTransfer: type: object description: |- An inbound transfer represents a transfer of funds from an external bank account to a financial account. required: - id - amount - created_at properties: id: type: string description: The unique identifier for the inbound transfer example: "inbound_transfer_01j8rs605a4gctmbm58d87mvsj" readOnly: true amount: type: integer format: int64 description: |- The amount of the inbound transfer in minor currency units (cents). This amount must be positive. example: 10000 description: type: string description: |- An arbitrary string attached to the object. Often useful for displaying to users. example: "InboundTransfer from my bank account" status: type: string description: |- The status of the inbound transfer. An Inbound Transfer is `pending` if it created and the funds haven't been received yet. The status changes to `completed` when the funds have been received and the balance of the financial account has been updated. The status changes to `canceled` if the transfer is canceled. The status changes to `failed` if the transfer fails. example: "pending" enum: - pending - completed - canceled - failed created_at: type: string format: date-time description: The date and time the inbound transfer was created example: "2020-01-31T23:00:00Z" readOnly: true updated_at: type: string format: date-time description: The date and time the inbound transfer was last updated example: "2020-01-31T23:00:00Z" readOnly: true Transaction: type: object description: | A transaction represents an individual line-item or donation for a recipient nonprofit organization. The transaction amount represents the gross amount, and an optional fee can be deducted to calculate the net amount that will be disbursed. required: - amount - net_amount - type properties: id: type: string description: The unique identifier for the transaction example: "txn_1LaXpKGUcADgqoEMl0Cx0Ygg" readOnly: true amount: type: integer format: int64 description: | The gross transaction amount in minor currency units (cents) before any fees are deducted. This represents the total amount of the donation. example: 10000 fee_amount: type: integer format: int64 description: | The fee amount in minor currency units (cents) to be deducted from the transaction amount. This is an optional field. If not provided, no fee will be deducted. The fee amount must be less than the transaction amount. example: 500 nullable: true net_amount: type: integer format: int64 description: | The net transaction amount in minor currency units (cents) after fees are deducted. This is calculated as: net_amount = amount - fee_amount. This is the actual amount that will be disbursed to the nonprofit. example: 9500 readOnly: true description: type: string description: | A description of the transaction. This description is displayed to the receiving organization. example: "Disbursement to nonprofit" type: $ref: "#/components/schemas/DonationType" donor_advised_fund_grant: $ref: "#/components/schemas/DonorAdvisedFundGrant" created_at: type: string format: date-time description: The date and time the transaction was created example: "2020-01-31T23:00:00Z" readOnly: true updated_at: type: string format: date-time description: The date and time the transaction was last updated example: "2020-01-31T23:00:00Z" readOnly: true metadata: type: object description: Additional metadata for the transaction additionalProperties: type: string DonationType: type: string description: The type of donation enum: - donor_advised_fund_grant # Can be added back in once we have a use case to disburse corporate matches or qualified charitable distributions # - corporate_match # - qualified_charitable_distribution DonorAdvisedFundGrant: type: object description: A donor-advised fund grant is a charitable donation made by a donor-advised fund (DAF) on behalf of the donor. properties: grant_id: type: string description: "A unique identifier for the grant within the DAF provider's internal system. Maximum length: 255 characters." example: "grant_1234567890" organization_name: type: string description: "The name of the DAF organization that made the grant. Maximum length: 255 characters." example: "Vanguard Charitable" fund_name: type: string description: "The name of the DAF fund that made the grant. Maximum length: 255 characters." example: "John Doe Fund" purpose: type: string description: "The purpose of the grant. Maximum length: 400 characters." example: "General Operating Support" note: type: string description: "A note about the grant. Maximum length: 400 characters." example: "This grant is for the general operating support of the organization." donors: type: array description: The list of donors for the transaction items: $ref: "#/components/schemas/Donor" Donor: type: object description: The donor information for the transaction properties: first_name: type: string description: "The first name of the donor. Maximum length: 255 characters." example: "John" last_name: type: string description: "The last name of the donor. Maximum length: 255 characters." example: "Doe" email: type: string description: "The email address of the donor. Maximum length: 255 characters." example: "bob@me.com" phone: type: string description: "The phone number of the donor. Maximum length: 20 characters." example: "415-555-1212" address: $ref: "#/components/schemas/Address" EventCategory: type: string description: | The category of the event. This is useful for filtering events. enum: - "grant.created" - "grant.updated" - "unintegrated_grant.created" - "unintegrated_grant.updated" - "disbursement.created" - "disbursement.updated" - "inbound_transfer.created" - "inbound_transfer.updated" Event: type: object description: | Events are records of things that happened to objects at Chariot. properties: id: type: string description: The unique identifier for the event example: "203c4e56-5c39-4a66-abcd-2ec8af99a1b9" readOnly: true category: $ref: "#/components/schemas/EventCategory" created_at: type: string format: date-time description: The date and time the event was created example: "2024-01-19T18:48:56.37Z" readOnly: true associated_object_id: type: string description: The unique identifier for the associated object example: "4d06d393-1f14-46cf-b02d-8db17d7ed06a" readOnly: true associated_object_type: type: string description: The type of the associated object example: "grant" readOnly: true EventSubscriptionStatus: type: string description: |- The status of the event subscription. This indicates if we'll send notifications to this subscription * active: subscription is active and events will be delivered normally * disabled: subscription is temporarily disabled and events will not be delivered * deleted: subscription has been deleted and events will not be delivered * requires_attention: subscription has been disabled due to delivery failures and events will not be delivered enum: - "active" - "disabled" - "deleted" - "requires_attention" EventSubscription: type: object description: | Webhooks are event notifications we send to you by HTTPS POST requests. Event Subscriptions are how you configure your application to listen for them. required: - url properties: id: type: string description: The unique identifier for the event subscription example: "4d06d393-1f14-46cf-b02d-8db17d7ed06a" readOnly: true created_at: type: string format: date-time description: The date and time the event subscription was created example: "2024-01-14T12:48:56.37Z" readOnly: true status: $ref: "#/components/schemas/EventSubscriptionStatus" url: type: string description: The webhook url where we'll send notifications. example: "https://example.com/webhook" category: $ref: "#/components/schemas/EventCategory" Program: type: object description: |- Programs encapsulate functional operations and allow for segregation of funds & activity on top of a Financial Account. By default, most organizations will have a Gift Processing program for managing inbound donation revenue. If you are disbursing funds to other nonprofits, we will work together to create a Grantmaking program for you. If there are other use cases where you need to segregate funds or activity, we will work together to create additional Programs for you. required: - id - name - grant_disbursement_status - gift_processing_status - created_at - updated_at properties: id: type: string description: The unique identifier for the program example: "program_01j8rs605a4gctmbm58d87mvsj" name: type: string description: The name of the program example: "Gift Processing" description: type: string description: A description of the program example: "This program is used to unify and standardize donation processing across all Donor-Advised Fund grants." grant_disbursement_status: type: string enum: - "enabled" - "disabled" description: |- The status of the program's ability to disburse grant payments to other eligible nonprofit recipients. example: "enabled" readOnly: true gift_processing_status: type: string enum: - "enabled" - "disabled" description: |- The status of the program's ability to connect payment sources to process donations and grants to your organization. example: "enabled" readOnly: true created_at: type: string format: date-time description: The date and time the program was created example: "2020-01-31T23:00:00Z" updated_at: type: string format: date-time description: The date and time the program was last updated example: "2020-01-31T23:00:00Z" Paging: type: object description: The paging information properties: next_page_token: type: string description: The token to use for pagination. If not set, the first page of results will be returned. example: "eyJpZCI6IjEyMzQ1Njc4OTAiLCJ0aW1lc3RhbXAiOiIyMDIwLTA3LTEwIDE1OjAwOjAwLjAwMCJ9" total: type: integer ProblemDetails: type: object description: >- RFC 7807 problem-details error (media type application/problem+json). The `status` field is an integer HTTP status code. required: - type - title - status - detail properties: type: type: string description: A URI reference identifying the problem type. example: about:blank title: type: string description: A short, human-readable summary of the problem type. example: API Error status: type: integer description: The HTTP status code for this error. example: 400 detail: type: string description: A human-readable explanation specific to this occurrence. example: The request is invalid or contains invalid parameters. example: type: about:blank title: "API Error" status: 400 detail: The request is invalid or contains invalid parameters. headers: X-Request-Id: description: The unique identifier for the request schema: type: string Location: description: The URI of the created object schema: type: string Idempotency-Key: description: Idempotency key for the request schema: type: string requestBodies: GrantCaptureRequest: description: |- The request to create and submit a grant. This is useful to capture a grant intent associated with DAFpay workflow session. The request should specify the grant amount. This is the amount submitted for processing by the DAF. required: true content: application/json: schema: type: object required: - workflowSessionId - amount properties: workflowSessionId: type: string description: |- The identifier of the donor's DAFpay Workflow Session. See [Capturing Grant Intents](/guides/dafpay/integrating-dafpay/integration#capturing-grant-intents) for how to get this value from the DAFpay `CHARIOT_SUCCESS` event. amount: type: number example: 15000 description: |- The grant amount in cents that will be processed by Chariot and submitted to the DAF. This amount must be in whole dollar increments (rounded to the nearest hundred) as currently all DAFs only accept whole dollar grant amounts. applicationFeeAmount: type: number example: 3000 description: |- This parameter specifies the fee your platform plans to take from the grant in cents. This is a fee in addition to Chariot's processing fee. With application fees, Chariot collects the fee you determine from the nonprofit and passes it to your platform. Please note that platform fees are only taken when the grant is successfully received by the nonprofit. The sum of Chariot's fee and the applicationFeeAmount cannot exceed 5% of the grant's amount. If the fee limit is exceeded, a `400 Bad Request` error will be returned. donor: type: object properties: firstName: type: string description: "The first name of the donor. Maximum length: 255 characters." lastName: type: string description: "The last name of the donor. Maximum length: 255 characters." email: type: string description: "The email address of the donor. Maximum length: 255 characters." phone: type: string description: "The phone number of the donor. Maximum length: 255 characters." address: $ref: "#/components/schemas/GrantAddress" note: type: string description: |- A note the donor wants to send to the nonprofit. Maximum length: 400 characters. designation: type: string description: |- The designation to include on the grant. If this is left blank, "Where needed most" will be used. Note that including a custom designation may cause the grant approval process to take longer. Maximum length: 100 characters. RecurringGrantCaptureRequest: description: |- The request to create and submit a monthly recurring grant. This is useful to capture a recurring grant intent associated with Connect workflow session. The request should specify the grant amount. The grant will re-occur according to the scheduled frequency or recurrence of the request. The recurring grant will continue indefinitely until the donor runs out of funds or until the donor cancels the recurring grant with their DAF provider. Some DAF providers require an end-date or number of payments in order to create a recurring grant. In most cases, the recurring grant will continue indefinitely until the donor's account runs out of funds or until the donor cancels the recurring grant with their DAF provider. Some DAF providers require an explicit bound to the time period or the number of payments in which case currently we opt for the longest recurring donation timeline possible. For example, if the DAF provider allows recurring donations to continue for up to 10 years we will submit the request as such. This is the amount submitted for processing by the DAF. required: true content: application/json: schema: type: object required: - workflowSessionId - amount - frequency properties: workflowSessionId: type: string description: |- The identifier of the donor's DAFpay Workflow Session. See [Capturing Grant Intents](/guides/dafpay/integrating-dafpay/integration#capturing-grant-intents) for how to get this value from the DAFpay `CHARIOT_SUCCESS` event. frequency: type: string description: |- The recurrence interval schedule for the recurring grant. Currently, only `MONTHLY` is supported. enum: - MONTHLY example: MONTHLY amount: type: number example: 15000 description: |- The final grant amount in cents that will be processed by Chariot and submitted to the DAF for recurring gifts. This amount must be in whole dollar increments (rounded to the nearest hundred) as currently all DAFs only accept whole dollar grants. applicationFeeAmount: type: number example: 3000 description: |- This parameter specifies the fee your platform plans to take from the first grant in cents. This is a fee in addition to Chariot's processing fee. With application fees, Chariot collects the fee you determine from the nonprofit and passes it to your platform. Please note that platform fees are only taken when the grant is successfully received by the nonprofit. The sum of Chariot's fee and the applicationFeeAmount cannot exceed 5% of the grant's amount. If the 5% limit is exceeded, a 400 error will be returned. donor: type: object properties: firstName: type: string description: "The first name of the donor. Maximum length: 255 characters." lastName: type: string description: "The last name of the donor. Maximum length: 255 characters." email: type: string description: "The email address of the donor. Maximum length: 255 characters." phone: type: string description: "The phone number of the donor. Maximum length: 255 characters." address: $ref: "#/components/schemas/GrantAddress" note: type: string description: |- A note the donor wants to send to the nonprofit. Maximum length: 400 characters. designation: type: string description: |- The designation to include on the grant. If this is left blank, "Where needed most" will be used. Note that including a custom designation may cause the grant approval process to take longer. Designations over 100 characters will be truncated. CreateConnectRequest: description: |- The request to create a new Connect object for a nonprofit. required: true content: application/json: schema: type: object required: - organization_id - contact properties: organization_id: type: string description: The unique identifier for the organization example: "org_1234567890" contact: type: object required: - email properties: email: type: string description: The email address for the nonprofit account contact example: ben.give@co.com phone: type: string description: The phone number for the nonprofit account contact example: "9127772424" first_name: type: string description: The first name of the nonprofit account contact that manages this Connect example: Ben last_name: type: string description: The last name of the nonprofit account contact that manages this Connect example: Give name: type: string description: |- A human readable name of the Connect, optional. metadata: type: object description: A map of arbitrary string keys and values to store information about the object. additionalProperties: type: string CreateDisbursementRequest: required: true content: application/json: schema: $ref: "#/components/schemas/CreateDisbursementInput" examples: MultipleTransactions: summary: Disbursement with multiple transactions value: organization_id: "org_01j8rs605a4gctmbm58d87mvsj" amount: 25000 transactions: [ { amount: 15000, description: "Grant from Doe Family Fund", type: "donor_advised_fund_grant", donor_advised_fund_grant: { grant_id: "grant_1234567890", organization_name: "Miami Charitable", fund_name: "Doe Family Charitable Fund", purpose: "General Operating Support", donors: [ { first_name: "Jane", last_name: "Doe", email: "jane.doe@example.com", }, ], }, }, { amount: 10000, description: "Grant from Smith Family Fund", type: "donor_advised_fund_grant", donor_advised_fund_grant: { organization_name: "LA Charitable", fund_name: "Smith Family Legacy Fund", purpose: "Program Support", donors: [ { first_name: "John", last_name: "Smith", email: "john.smith@example.com", }, ], }, }, ] MultipleTransactionsWithFees: summary: Disbursement with multiple transactions including fees value: organization_id: "org_01j8rs605a4gctmbm58d87mvsj" amount: 24000 transactions: [ { amount: 15000, fee_amount: 500, description: "Grant from Doe Family Fund", type: "donor_advised_fund_grant", donor_advised_fund_grant: { grant_id: "grant_1234567890", organization_name: "Miami Charitable", fund_name: "Doe Family Charitable Fund", purpose: "General Operating Support", donors: [ { first_name: "Jane", last_name: "Doe", email: "jane.doe@example.com", }, ], }, }, { amount: 10000, fee_amount: 500, description: "Grant from Smith Family Fund", type: "donor_advised_fund_grant", donor_advised_fund_grant: { organization_name: "LA Charitable", fund_name: "Smith Family Legacy Fund", purpose: "Program Support", donors: [ { first_name: "John", last_name: "Smith", email: "john.smith@example.com", }, ], }, }, ] CreateInboundTransferRequest: description: The request body for originating an inbound transfer from an external bank account required: true content: application/json: schema: type: object required: - amount - account_id properties: amount: type: number description: |- The amount of the transfer in cents. This amount must be positive. example: 10000 account_id: type: string description: |- The identifier of the financial account that will receive the transfer. example: "account_01jpjenf5q6cawy43yxfcrxhct" description: type: string description: An arbitrary string attached to the object. Often useful for displaying to users. example: "Inbound ACH Transfer from my bank account" StopDisbursementRequest: description: The request body for stopping a disbursement payment required: true content: application/json: schema: type: object required: - reason properties: reason: $ref: "#/components/schemas/StopDisbursementPaymentReason" CreateEventSubscriptionRequest: description: The request body for creating an event subscription required: true content: application/json: schema: type: object required: - url - category properties: url: type: string description: The webhook url where we'll send notifications. example: "https://example.com/webhook" category: $ref: "#/components/schemas/EventCategory" signing_secret: type: string description: |- The key that will be used to sign webhooks. If no value is passed, a random string will be used as default. This is necessary to verify that the webhook is coming from Chariot. While this parameter is optional, it is highly recommended to pass a value for the secret and implement webhook signature verification. UpdateEventSubscriptionRequest: description: The request body for creating an event subscription required: true content: application/json: schema: type: object properties: status: type: string description: |- The status of the event subscription: * active: The event subscription is active and events will be delivered * disabled: The event subscription is temporarily disabled and events will not be delivered * deleted: The event subscription is permanently deleted and events will not be delivered enum: - "active" - "disabled" - "deleted" responses: ListFinancialAccountsResponse: description: The response for FinancialAccounts.list headers: X-Request-Id: $ref: "#/components/headers/X-Request-Id" content: application/json: schema: type: object properties: results: type: array items: $ref: "#/components/schemas/FinancialAccount" next_page_token: type: string description: |- A cursor token to use to retrieve the next page of results by making another API call to the same endpoint with the same parameters (only substituting the pageToken with this value). If specified, then more results exist on the server that were not returned, otherwise no more results exist on the server. ListDafsResponse: description: The response for Dafs.list headers: X-Request-Id: $ref: "#/components/headers/X-Request-Id" content: application/json: schema: type: object properties: results: type: array items: $ref: "#/components/schemas/Daf" nextPageToken: type: string description: |- A cursor token to use to retrieve the next page of results by making another API call to the same endpoint with the same parameters (only substituting the pageToken with this value). If specified, then more results exist on the server that were not returned, otherwise no more results exist on the server. example: results: - id: "0bf40881-8ee2-47fb-98ca-f58c7999aa34" orgName: "National Philanthropic Trust" address: "123 Main St." address2: "Apt 100" city: "New York" state: "NY" zip: "12345" supported: true minimumGrantAmount: 5000 institutionDown: false nextPageToken: "c3f685f2-2dda-4956-815b-39867a5e5638" ListGrantsResponse: description: The response for Grants.list headers: X-Request-Id: $ref: "#/components/headers/X-Request-Id" content: application/json: schema: type: object properties: results: type: array items: $ref: "#/components/schemas/Grant" nextPageToken: type: string nullable: true description: |- A cursor token to use to retrieve the next page of results by making another API call to the same endpoint with the same parameters (only changing the pageToken). If specified, then more results exist on the server that were not returned, otherwise no more results exist on the server. example: results: - id: "1e60800e-849b-43d1-870e-57afc8d75473" workflowSessionId: "cfe09e64-6a74-4dab-a565-361185a6f248" fundId: "daf-id" createdAt: "2021-08-10 15:00:00.000" updatedAt: "2021-08-11 15:34:00.000" amount: 15000 status: "Initiated" nextPageToken: "c3f685f2-2dda-4956-815b-39867a5e5638" ListRecurringGrantsResponse: description: The response for RecurringGrants.list headers: X-Request-Id: $ref: "#/components/headers/X-Request-Id" content: application/json: schema: type: object properties: results: type: array items: $ref: "#/components/schemas/RecurringGrant" nextPageToken: type: string description: |- A cursor token to use to retrieve the next page of results by making another API call to the same endpoint with the same parameters (only changing the pageToken). If specified, then more results exist on the server that were not returned, otherwise no more results exist on the server. example: results: - id: "29650c10-1eb3-4f97-a63e-f2e41c145b53" workflowSessionId: "b76fa69f-c554-43b2-af9a-1d4bb9a02016" fundId: "daf-id" createdAt: "2021-08-10 15:00:00.000" updatedAt: "2021-08-11 15:34:00.000" amount: 15000 frequency: MONTHLY nextPageToken: "c3f685f2-2dda-4956-815b-39867a5e5638" ListUnintegratedGrantsResponse: description: The response for UnintegratedGrants.list headers: X-Request-Id: $ref: "#/components/headers/X-Request-Id" content: application/json: schema: type: object properties: results: type: array items: $ref: "#/components/schemas/UnintegratedGrant" nextPageToken: type: string description: |- A cursor token to use to retrieve the next page of results by making another API call to the same endpoint with the same parameters (only changing the pageToken). If specified, then more results exist on the server that were not returned, otherwise no more results exist on the server. example: results: - id: "1e60800e-849b-43d1-870e-57afc8d75473" workflowSessionId: "cfe09e64-6a74-4dab-a565-361185a6f248" fundId: "daf-id" createdAt: "2021-08-10 15:00:00.000" updatedAt: "2021-08-11 15:34:00.000" amount: 15000 nextPageToken: "c3f685f2-2dda-4956-815b-39867a5e5638" ListEventsResponse: description: The response for Events.list headers: X-Request-Id: $ref: "#/components/headers/X-Request-Id" content: application/json: schema: type: object properties: results: type: array items: $ref: "#/components/schemas/Event" nextPageToken: type: string description: |- A cursor token to use to retrieve the next page of results by making another API call to the same endpoint with the same parameters (only changing the pageToken). If specified, then more results exist on the server that were not returned, otherwise no more results exist on the server. ListEventSubscriptionsResponse: description: The response for Events.list headers: X-Request-Id: $ref: "#/components/headers/X-Request-Id" content: application/json: schema: type: object properties: results: type: array items: $ref: "#/components/schemas/EventSubscription" nextPageToken: type: string description: |- A cursor token to use to retrieve the next page of results by making another API call to the same endpoint with the same parameters (only changing the pageToken). If specified, then more results exist on the server that were not returned, otherwise no more results exist on the server. SearchOrganizationsResponse: description: The response for Organizations.search headers: X-Request-Id: $ref: "#/components/headers/X-Request-Id" content: application/json: schema: type: object properties: results: type: array items: $ref: "#/components/schemas/OrganizationSummary" ListDisbursementsResponse: description: The response for Disbursements.list headers: X-Request-Id: $ref: "#/components/headers/X-Request-Id" content: application/json: schema: type: object properties: results: type: array items: $ref: "#/components/schemas/Disbursement" next_page_token: type: string description: |- A cursor token to use to retrieve the next page of results by making another API call to the same endpoint with the same parameters (only changing the pageToken). If specified, then more results exist on the server that were not returned, otherwise no more results exist on the server. ListInboundTransfersResponse: description: The response for InboundTransfers.list headers: X-Request-Id: $ref: "#/components/headers/X-Request-Id" content: application/json: schema: type: object properties: results: type: array items: $ref: "#/components/schemas/InboundTransfer" nextPageToken: type: string description: |- A cursor token to use to retrieve the next page of results by making another API call to the same endpoint with the same parameters (only changing the pageToken). If specified, then more results exist on the server that were not returned, otherwise no more results exist on the server. ListProgramsResponse: description: The response for Programs.list headers: X-Request-Id: $ref: "#/components/headers/X-Request-Id" content: application/json: schema: type: object properties: results: type: array items: $ref: "#/components/schemas/Program" next_page_token: type: string description: |- A cursor token to use to retrieve the next page of results by making another API call to the same endpoint with the same parameters (only changing the pageToken). If specified, then more results exist on the server that were not returned, otherwise no more results exist on the server. BadRequestError: description: The request is invalid or contains invalid parameters headers: X-Request-Id: $ref: "#/components/headers/X-Request-Id" content: application/problem+json: schema: $ref: "#/components/schemas/ProblemDetails" examples: BadRequest: value: type: about:blank title: "API Error" status: 400 detail: "The request is invalid or contains invalid parameters." AuthenticationError: description: Unauthorized. The request is missing the security (OAuth2 Bearer token) requirements and the server is unable to verify the identify of the caller. headers: X-Request-Id: $ref: "#/components/headers/X-Request-Id" content: application/problem+json: schema: $ref: "#/components/schemas/ProblemDetails" examples: Unauthorized: value: type: about:blank title: "API Error" status: 401 detail: "Authentication credentials were missing or invalid." ForbiddenError: description: Access denied headers: X-Request-Id: $ref: "#/components/headers/X-Request-Id" content: application/problem+json: schema: $ref: "#/components/schemas/ProblemDetails" examples: Forbidden: value: type: about:blank title: "API Error" status: 403 detail: "You do not have permission to access this resource." NotFoundError: description: Resource Not Found headers: X-Request-Id: $ref: "#/components/headers/X-Request-Id" content: application/problem+json: schema: $ref: "#/components/schemas/ProblemDetails" examples: NotFound: value: type: about:blank title: "API Error" status: 404 detail: "The requested resource was not found." ConflictError: description: Resource Conflicts headers: X-Request-Id: $ref: "#/components/headers/X-Request-Id" content: application/problem+json: schema: $ref: "#/components/schemas/ProblemDetails" examples: Conflict: value: type: about:blank title: "API Error" status: 409 detail: "The request conflicts with the current state of the resource." GoneError: description: Resource Gone or Expired headers: X-Request-Id: $ref: "#/components/headers/X-Request-Id" content: application/problem+json: schema: $ref: "#/components/schemas/ProblemDetails" examples: Gone: value: type: about:blank title: "API Error" status: 410 detail: "The resource is no longer available." PreconditionFailedError: description: Precondition Failed headers: X-Request-Id: $ref: "#/components/headers/X-Request-Id" content: application/problem+json: schema: $ref: "#/components/schemas/ProblemDetails" examples: PreconditionFailed: value: type: about:blank title: "API Error" status: 412 detail: "A precondition for the request was not met." InternalServerError: description: Internal Server Error headers: X-Request-Id: $ref: "#/components/headers/X-Request-Id" content: application/problem+json: schema: $ref: "#/components/schemas/ProblemDetails" examples: InternalServerError: value: type: about:blank title: "API Error" status: 500 detail: "The server encountered an error processing your request." examples: NonprofitRedCross: summary: American Red Cross value: id: "021cf6aa-cb91-4b92-ae03-82a211cc8328" name: "American Red Cross" ein: "530196605" createdAt: "2021-07-10 15:00:00.000" updatedAt: "2020-01-31T23:59:59Z" isDafPayNetwork: false inGoodStanding: true ConnectOutput: summary: Simple connect output value: id: "test_de5a2e7d-c960-4eaa-8bd2-e8d2cc5b1a55" name: "website" apiKey: "test_98235982835" active: true createdAt: "2021-07-10 15:00:00.000" updatedAt: "2020-01-31T23:59:59Z" createdBy: "user123" metadata: tag1: "value1" GrantOutput: summary: Simple grant output value: id: "1e60800e-849b-43d1-870e-57afc8d75473" workflowSessionId: "cfe09e64-6a74-4dab-a565-361185a6f248" fundId: "daf-id" createdAt: "2021-08-10 15:00:00.000" updatedAt: "2021-08-11 15:34:00.000" amount: 15000 status: "Initiated" RecurringGrantOutput: summary: Simple recurring grant output. value: id: "1e60800e-849b-43d1-870e-57afc8d75473" workflowSessionId: "cfe09e64-6a74-4dab-a565-361185a6f248" fundId: "daf-id" createdAt: "2021-08-10 15:00:00.000" updatedAt: "2021-08-11 15:34:00.000" amount: 15000 frequency: MONTHLY UnintegratedGrantOutput: summary: Simple unintegrated grant output value: id: "1e60800e-849b-43d1-870e-57afc8d75473" workflowSessionId: "cfe09e64-6a74-4dab-a565-361185a6f248" fundId: "daf-id" createdAt: "2021-08-10 15:00:00.000" updatedAt: "2021-08-11 15:34:00.000" amount: 15000 DafOutput: summary: NPT DAF value: id: "0bf40881-8ee2-47fb-98ca-f58c7999aa34" orgName: "National Philanthropic Trust" address: "123 Main St." address2: "Apt 100" city: "New York City" state: "New York" zip: "12345" supported: true minimumGrantAmount: 25000 institutionDown: false