Create Recurring Grant
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 is captured once per workflow session. A repeat request for a session that already produced a recurring grant returns status
200 OKwith that grant; a request made while submission is still in progress returns status409 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. - If the DAF provider does not recognize the nonprofit, the request will return status
404 Not Found. - If the nonprofit cannot receive DAF gifts, for example because it is not in good standing with the IRS, the request will return status
412 Precondition Failed. - If the DAF provider is down or the submission fails, the request will return status
502 Bad Gateway. Retrying a502submits the grant to the provider again. - Any inputs exceeding the maximum allowed length will be automatically truncated unless otherwise stated.
Authentication
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.
The identifier of the donor’s DAFpay Workflow Session.
See Handle the Result for how to get this value from the DAFpay CHARIOT_SUCCESS event.
The recurrence interval schedule for the recurring grant. Currently, only MONTHLY is supported.
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.
A note the donor wants to send to the nonprofit. Maximum length: 400 characters.
Response headers
Response
Time when this object was created; expressed in RFC 3339 format
Time when this object was last updated; expressed in RFC 3339 format

