Create Recurring Grant

post

https://sandboxapi.givechariot.com/v1/recurring_grants

Create a recurring grant from a workflow session. This is useful to capture a recurring grant intent from an authorized connect workflow session and submit the recurring grant request.
The recurring grant must be captured within 5 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 grant 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 for the first grant must be less than or equal to the user's DAF account balance otherwise the request will return status 400 Bad Request.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

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.

workflowSessionId

string

required

The identifier of the Workflow Session

frequency

string

enum

required

How often the DAF provider will submit the recurring grant. At the moment, monthly is the only supported frequency.

Allowed:

amount

number

required

The final grant amount in cents that will be processed by Chariot and submitted to the DAF for monthly 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

number

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

object

address

object

Responses

201Created recurring grant

400The request is invalid or contains invalid parameters

401Unauthorized. The request is missing the security (OAuth2 Bearer token) requirements and the server is unable to verify the identify of the caller.

403Access denied

404Resource Not Found

409Resource Conflicts

410Resource Gone or Expired

500Internal Server Error