For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
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.
<Warning>
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.
</Warning>
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.
Authentication
AuthorizationBearer
Bearer authentication of the form Bearer <token>, where token is your auth token.
Request
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.
workflowSessionIdstringRequired
The identifier of the donor’s DAFpay Workflow Session.
See Capturing Grant Intents for how to get this value from the DAFpay CHARIOT_SUCCESS event.
frequencyenumRequired
The recurrence interval schedule for the recurring grant. Currently, only MONTHLY is supported.
Allowed values:
amountdoubleRequired
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.
applicationFeeAmountdoubleOptional
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.
donorobjectOptional
notestringOptional
A note the donor wants to send to the nonprofit. Maximum length: 400 characters.
designationstringOptional
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.
Response
Created recurring grant
idstringRead-onlyformat: "uuid"
The unique identifier for the object
workflowSessionIdstringRead-onlyformat: "uuid"
ID of the Connect Workflow Session associated with this grant
fundIdstringRead-only
ID of the donor advised fund
frequencyenum
How often the DAF provider will submit the recurring grant. At the moment, monthly is the only supported frequency.
Allowed values:
amountdouble
The grant amount expressed in units of whole cents
trackingIdstringRead-only
The tracking ID for the grant
externalRecurringGrantIdstring
ID of the grant associated with the donor advised fund
createdAtstringRead-onlyformat: "date-time"
Time when this object was created; expressed in RFC 3339 format
updatedAtstringRead-onlyformat: "date-time"
Time when this object was last updated; expressed in RFC 3339 format
firstNamestring
The donor's first name
lastNamestring
The donor's last name
phonestring
The donor's phone number
emailstring
The donor's email
notestring
An note inputted by the user at submisson
addressobject
Errors
400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
410
Gone Error
500
Internal Server Error
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.
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.
