Grants

Get Grant

Retrieve a grant with the given ID.

get/v1/grants/{id}

Path parameters

idstring uuid required

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

Response

OK

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"
}

Changes

Changed in 8 of the 41 revisions of this API.251454

  • b87f7738d3361025See the full diff
    • removed the required property code from the response with the 400 status

      response-required-property-removed

    • removed the required property code from the response with the 401 status

      response-required-property-removed

    • removed the required property code from the response with the 403 status

      response-required-property-removed

    • removed the required property code from the response with the 404 status

      response-required-property-removed

    • removed the required property code from the response with the 500 status

      response-required-property-removed

    • removed the required property message from the response with the 400 status

      response-required-property-removed

    • removed the required property message from the response with the 401 status

      response-required-property-removed

    • removed the required property message from the response with the 403 status

      response-required-property-removed

    • removed the required property message from the response with the 404 status

      response-required-property-removed

    • removed the required property message from the response with the 500 status

      response-required-property-removed

    • media type application/json was changed to a more specific media type application/problem+json for the response status 400

      response-media-type-name-specialized

    • media type application/json was changed to a more specific media type application/problem+json for the response status 401

      response-media-type-name-specialized

    • media type application/json was changed to a more specific media type application/problem+json for the response status 403

      response-media-type-name-specialized

    • media type application/json was changed to a more specific media type application/problem+json for the response status 404

      response-media-type-name-specialized

    • media type application/json was changed to a more specific media type application/problem+json for the response status 500

      response-media-type-name-specialized

    • added the required property detail to the response with the 400 status

      response-required-property-added

    • added the required property detail to the response with the 401 status

      response-required-property-added

    • added the required property detail to the response with the 403 status

      response-required-property-added

    • added the required property detail to the response with the 404 status

      response-required-property-added

    • added the required property detail to the response with the 500 status

      response-required-property-added

    • added the required property status to the response with the 400 status

      response-required-property-added

    • added the required property status to the response with the 401 status

      response-required-property-added

    • added the required property status to the response with the 403 status

      response-required-property-added

    • added the required property status to the response with the 404 status

      response-required-property-added

    • added the required property status to the response with the 500 status

      response-required-property-added

    • added the required property title to the response with the 400 status

      response-required-property-added

    • added the required property title to the response with the 401 status

      response-required-property-added

    • added the required property title to the response with the 403 status

      response-required-property-added

    • added the required property title to the response with the 404 status

      response-required-property-added

    • added the required property title to the response with the 500 status

      response-required-property-added

    • added the required property type to the response with the 400 status

      response-required-property-added

    • added the required property type to the response with the 401 status

      response-required-property-added

    • added the required property type to the response with the 403 status

      response-required-property-added

    • added the required property type to the response with the 404 status

      response-required-property-added

    • added the required property type to the response with the 500 status

      response-required-property-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • removed the optional property details from the response with the 400 status

      response-optional-property-removed

    • removed the optional property details from the response with the 401 status

      response-optional-property-removed

    • removed the optional property details from the response with the 403 status

      response-optional-property-removed

    • removed the optional property details from the response with the 404 status

      response-optional-property-removed

    • removed the optional property details from the response with the 500 status

      response-optional-property-removed

    • added the optional property details/items/debug to the response with the 400 status

      response-optional-property-added

    • added the optional property details/items/debug to the response with the 401 status

      response-optional-property-added

    • added the optional property details/items/debug to the response with the 403 status

      response-optional-property-added

    • added the optional property details/items/debug to the response with the 404 status

      response-optional-property-added

    • added the optional property details/items/debug to the response with the 500 status

      response-optional-property-added

    • added the optional property details/items/type to the response with the 400 status

      response-optional-property-added

    • added the optional property details/items/type to the response with the 401 status

      response-optional-property-added

    • added the optional property details/items/type to the response with the 403 status

      response-optional-property-added

    • added the optional property details/items/type to the response with the 404 status

      response-optional-property-added

    • added the optional property details/items/type to the response with the 500 status

      response-optional-property-added

    • added the optional property details/items/value to the response with the 400 status

      response-optional-property-added

    • added the optional property details/items/value to the response with the 401 status

      response-optional-property-added

    • added the optional property details/items/value to the response with the 403 status

      response-optional-property-added

    • added the optional property details/items/value to the response with the 404 status

      response-optional-property-added

    • added the optional property details/items/value to the response with the 500 status

      response-optional-property-added

  • 90671617b825155See the full diff
    • the code response's property type/format changed from number/ to string/ for status 400

      response-property-type-changed

    • the code response's property type/format changed from number/ to string/ for status 401

      response-property-type-changed

    • the code response's property type/format changed from number/ to string/ for status 403

      response-property-type-changed

    • the code response's property type/format changed from number/ to string/ for status 404

      response-property-type-changed

    • the code response's property type/format changed from number/ to string/ for status 500

      response-property-type-changed

    • removed the required property error from the response with the 400 status

      response-required-property-removed

    • removed the required property error from the response with the 401 status

      response-required-property-removed

    • removed the required property error from the response with the 403 status

      response-required-property-removed

    • removed the required property error from the response with the 404 status

      response-required-property-removed

    • removed the required property error from the response with the 500 status

      response-required-property-removed

    • removed the required property timestamp from the response with the 400 status

      response-required-property-removed

    • removed the required property timestamp from the response with the 401 status

      response-required-property-removed

    • removed the required property timestamp from the response with the 403 status

      response-required-property-removed

    • removed the required property timestamp from the response with the 404 status

      response-required-property-removed

    • removed the required property timestamp from the response with the 500 status

      response-required-property-removed

    • added the optional property details to the response with the 400 status

      response-optional-property-added

    • added the optional property details to the response with the 401 status

      response-optional-property-added

    • added the optional property details to the response with the 403 status

      response-optional-property-added

    • added the optional property details to the response with the 404 status

      response-optional-property-added

    • added the optional property details to the response with the 500 status

      response-optional-property-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 412b6fc0ed4e11See the full diff
    • added the new canceled enum value to the statuses/items/status response property for the response status 200

      response-property-enum-value-added

    • removed the cancelled enum value from the statuses/items/status response property for the response status 200

      response-property-enum-value-removed

  • e82b2918c9fb46See the full diff
    • added the new awaiting_account_approval enum value to the statuses/items/status response property for the response status 200

      response-property-enum-value-added

    • added the new awaiting_daf_submission enum value to the statuses/items/status response property for the response status 200

      response-property-enum-value-added

    • added the new cancelled enum value to the statuses/items/status response property for the response status 200

      response-property-enum-value-added

    • added the new initiated enum value to the statuses/items/status response property for the response status 200

      response-property-enum-value-added

    • removed the Approved enum value from the statuses/items/status response property for the response status 200

      response-property-enum-value-removed

    • removed the Canceled enum value from the statuses/items/status response property for the response status 200

      response-property-enum-value-removed

    • removed the Completed enum value from the statuses/items/status response property for the response status 200

      response-property-enum-value-removed

    • removed the Initiated enum value from the statuses/items/status response property for the response status 200

      response-property-enum-value-removed

    • removed the PendingDonorAccountApproval enum value from the statuses/items/status response property for the response status 200

      response-property-enum-value-removed

    • removed the Rejected enum value from the statuses/items/status response property for the response status 200

      response-property-enum-value-removed

    • removed the optional property donorAccountId from the response with the 200 status

      response-optional-property-removed

    • added the optional property donor_account_id to the response with the 200 status

      response-optional-property-added

    • added the new Approved enum value to the statuses/items/status response property for the response status 200

      response-property-enum-value-added

    • added the new PendingDonorAccountApproval enum value to the statuses/items/status response property for the response status 200

      response-property-enum-value-added

    • added the new Rejected enum value to the statuses/items/status response property for the response status 200

      response-property-enum-value-added

    • added the optional property donorAccountId to the response with the 200 status

      response-optional-property-added