Sign in

v39

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-017897360.9 KB
Grants

Sandbox: Cancel a grant

Simulates the DAF sponsor canceling the grant. Transitions the grant status to canceled.

<Note title="Sandbox Only" icon="fa-light fa-atom-simple"> This API is only available in the sandbox environment. </Note>
post/v1/simulations/grants/{id}/cancel

Path parameters

idstring uuid required

The unique identifier for the grant.

Response

The updated grant

idstring uuid required

The unique identifier for the object

userFriendlyIdstring

Often referred to as the "Chariot ID", this is the ID that will be included in the payment from the DAF provider.

trackingIdstring

The tracking ID for the grant

workflowSessionIdstring uuid required

ID of the Connect Workflow Session associated with this grant

fundIdstring required

ID of the donor advised fund

donor_account_idstring

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.

externalGrantIdstring

ID of the grant associated with the donor advised fund

createdAtstring date-time

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

updatedAtstring date-time

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

amountnumber required

The grant amount expressed in units of whole cents

statusstring

The status of the grant

metadataobject

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

firstNamestring

The donor's first name

lastNamestring

The donor's last name

phonestring

The donor's phone number

emailstring

The donor's email

notestring

An note inputted by the user at submisson

paymentChannel'dafpay_network' | 'direct'

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.

Example response

{
  "id": "cfe09e64-6a74-4dab-a565-361185a6f248",
  "userFriendlyId": "chariot-1234455",
  "trackingId": "L9E182VBGP",
  "workflowSessionId": "2d4b2a43-a5b4-4be1-ad1f-f932016ca4a6",
  "fundId": "daf-id",
  "donor_account_id": "donor_account_01jpjenf5q6cawy43yxfcrxhct",
  "externalGrantId": "897823sdjf8sfjs",
  "createdAt": "2020-01-31T23:00:00Z",
  "updatedAt": "2020-01-31T23:59:59Z",
  "amount": 15000,
  "status": "Initiated",
  "feeDetail": {
    "total": 1500,
    "contributions": [
      {
        "name": "Chariot",
        "amount": 1500,
        "feeType": "chariot"
      }
    ]
  },
  "firstName": "Warren",
  "lastName": "Buffet",
  "phone": "1237861020",
  "email": "warrenBuffet@example.com",
  "note": "Please dedicate in memory of grandma",
  "statuses": [
    {
      "id": "cfe09e64-6a74-4dab-a565-361185a6f248",
      "createdAt": "2020-01-31T23:00:00Z",
      "status": "awaiting_daf_submission",
      "comment": "The grant has been received by the nonprofit"
    }
  ],
  "paymentChannel": "direct"
}