Skip to navigation
DAFpayGrants

Sandbox: Complete a grant

Simulates the DAF sponsor completing a grant. Transitions the grant status to completed.

Sandbox Only

This API is only available in the sandbox environment.

Authentication

AuthorizationBearer

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

Path parameters

idstringRequiredformat: "uuid"
The unique identifier for the grant.

Response

The updated 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
amountdouble
The grant amount expressed in units of whole cents
trackingIdstringOptionalRead-only
The tracking ID for the grant
donor_account_idstringOptionalRead-only

ID of the Donor Account that this grant was submitted from. Present on grants submitted by donors who authenticated through the DAFpay Donor Account flow. Grants submitted without a linked Donor Account will not have this field set.

donation_idstringOptionalRead-only

ID of the Donation produced by this grant. Populated once the grant has produced a donation. Newly-created grants and grants that have not yet produced a donation do not have this field set.

externalGrantIdstringOptional
ID of the grant associated with the donor advised fund
createdAtdatetimeOptionalRead-only

Time when this object was created; expressed in RFC 3339 format

updatedAtdatetimeOptionalRead-only

Time when this object was last updated; expressed in RFC 3339 format

statusstringOptional
The status of the grant
feeDetailobjectOptionalRead-only
The fee detail of the grant
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
notestringOptional
An note inputted by the user at submisson
statuseslist of objectsOptional
The list of grant statuses for this grant
paymentChannelenumOptionalRead-only

The payment channel for the grant. This is useful to know how the grant will be sent. The payment channel will be one of the following:

  • dafpay_network: Grant will be sent to the DAFPay Network 501(c)(3) nonprofit organization (EIN: 93-1372175). The DAFPay Network will then review and process the grant and send the funds to the intended recipient.
  • direct: Grant will be sent directly to the intended recipient.
Allowed values:
addressobjectOptional
userFriendlyIdstringOptionalRead-onlyDeprecated
Often referred to as the "Chariot ID", this is the ID that will be included in the payment from the DAF provider.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error