DAFpayRecurring Grants

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 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.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
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.

frequency"MONTHLY"Required

The recurrence interval schedule for the recurring grant. Currently, only MONTHLY is supported.

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
idstringformat: "uuid"
The unique identifier for the object
workflowSessionIdstringformat: "uuid"
ID of the Connect Workflow Session associated with this grant
fundIdstring
ID of the donor advised fund
frequency"MONTHLY"
How often the DAF provider will submit the recurring grant. At the moment, monthly is the only supported frequency.
amountdouble
The grant amount expressed in units of whole cents
trackingIdstring or null
The tracking ID for the grant
externalGrantIdstring or null
ID of the grant associated with the donor advised fund
createdAtdatetime or null

Time when this object was created; expressed in ISO 8601 format

updatedAtdatetime or null

Time when this object was last updated; expressed in ISO 8601 format

firstNamestring or null
The donor's first name
lastNamestring or null
The donor's last name
phonestring or null
The donor's phone number
emailstring or null
The donor's email
notestring or null
An note inputted by the user at submisson
addressobject or null

Errors