Update Unintegrated Grant

PATCH
/v1/unintegrated_grants/:id

Update an unintegrated grant object with the given ID. This can be used to update the status or acknowledgement of the unintegrated grant.

Path parameters

idstringRequired

The unique id of the unintegrated grant. The format should be a v4 UUID according to RFC 4122.

Request

This endpoint expects an object.
status"Initiated" or "Completed"Optional
Allowed values: InitiatedCompleted

The status of the grant:

  • Initiated: The grant has been initiated and is ready to be processed
  • Completed: The grant has been completed
acknowledgedAtdatetimeOptional

The date and time the grant was acknowledged by the nonprofit. This is useful for nonprofits to indicate when they have received and processed the grant. Expressed in ISO 8601 format.

Response

This endpoint returns an object.
idstring

The unique identifier for the object

workflowSessionIdstring

ID of the Connect Workflow Session associated with this grant

fundIdstring

ID of the donor advised fund

amountdouble

The grant amount expressed in units of whole cents

trackingIdstringOptional

The tracking ID for the unintegrated grant

createdAtdatetimeOptional

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

updatedAtdatetimeOptional

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

statusenumOptional
Allowed values: UnknownInitiatedCompletedCanceled

The status of the unintegrated grant. To see a description of each status, see the “Unintegrated Grant Statuses” section of the Chariot documentation.

metadatamap from strings to stringsOptional

A map of arbitrary string keys and values to store information about the object

firstNamestringOptional

The donor’s first name

lastNamestringOptional

The donor’s last name

phonestringOptional

The donor’s phone number

emailstringOptional

The donor’s email

addressobjectOptional
notestringOptional

An note inputted by the user at submisson

paymentChannel"offline"OptionalDefaults to offline

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

Often refered to as the “Chariot ID”, this is the ID that will be included in the payment from the DAF provider.

Errors

Built with