diff --git a/fern/docs.yml b/fern/docs.yml index ff307fe..e9f7860 100644 --- a/fern/docs.yml +++ b/fern/docs.yml @@ -4,13 +4,9 @@ instances: title: Chariot Documentation versions: - - display-name: v2.0 - path: versions/v2.0/docs.yml - - display-name: v1.8 - path: versions/v1.8/docs.yml - - display-name: v1.7 - path: versions/v1.7/docs.yml - + - display-name: v1 + path: versions/v1/docs.yml + colors: accentPrimary: light: "#35BBF4" diff --git a/fern/versions/v1.7/docs.yml b/fern/versions/v1.7/docs.yml deleted file mode 100644 index d1670e7..0000000 --- a/fern/versions/v1.7/docs.yml +++ /dev/null @@ -1,45 +0,0 @@ -navigation: - - section: Documentation - contents: - - section: Getting Started - contents: - - page: Overview - path: ./pages/getting-started/how-chariot-works.mdx - - page: Quick Start - path: ./pages/getting-started/quickstart.mdx - - page: Navigating the Docs - path: ./pages/getting-started/navigating-the-docs.mdx - - page: FAQ - path: ./pages/getting-started/faq.mdx - - section: Connect (FRONTEND) - contents: - - page: Integrating Connect (DAFpay) - path: ./pages/connect-frontend/integrating-connect.mdx - - page: Button Styles - path: ./pages/connect-frontend/button-styles.mdx - - page: Workflow Configurations - path: ./pages/connect-frontend/configurations.mdx - - page: Error Handling & Edge Cases - path: ./pages/connect-frontend/error-handling-1.mdx - - section: API (BACKEND) - contents: - - page: Overview - path: ./pages/api-backend/overview.mdx - - page: Authentication - path: ./pages/api-backend/authentication-1.mdx - - page: Error Codes - path: ./pages/api-backend/errors-1.mdx - - page: Grant Statuses - path: ./pages/api-backend/grant-statuses.mdx - - page: Postman - path: ./pages/api-backend/postman.mdx - - page: Webhooks and Events - path: ./pages/api-backend/webhooks-and-events.mdx - - api: API Reference - display-errors: true - snippets: - typescript: chariot - layout: - - auth - - DAFs: - title: Donor Advised Funds \ No newline at end of file diff --git a/fern/versions/v1.7/pages/api-backend/authentication-1.mdx b/fern/versions/v1.7/pages/api-backend/authentication-1.mdx deleted file mode 100644 index 513de56..0000000 --- a/fern/versions/v1.7/pages/api-backend/authentication-1.mdx +++ /dev/null @@ -1,173 +0,0 @@ ---- -title: "Authentication" -slug: "authentication-1" -subtitle: "" -hidden: false -createdAt: "Wed Jun 01 2022 23:44:11 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Tue Dec 12 2023 22:09:32 GMT+0000 (Coordinated Universal Time)" ---- -## API access - -In order to access the Chariot API, you will need to authenticate requests using the OAuth 2.0 [Client Credentials](https://auth0.com/docs/get-started/authentication-and-authorization-flow/client-credentials-flow) flow. - -- **OAuth 2.0 Access Token**: This is a JWT that should be provided as a Bearer token in the Authorization header for all API endpoints. This Access Token is temporary and once it expires you can request a new one. We recommend you save these tokens somewhere safe and re-use them until they expire so you can avoid having to re-fetch which can add latency to your requests. - -To obtain the necessary `client_id` and `client_secret` please email [support@givechariot.com](mailto:support@givechariot.com). - -### Getting an OAuth2.0 Access Token for your API - -You can execute a client credentials exchange to get an access token for Chariot. Here are a few examples in a variety of languages. Replace any `CLIENT_ID` and `CLIENT_SECRET` with the ones privately shared with you. Note that in this example we are retrieving an access token for the Chariot Sandbox environment. If you wanted to retrieve an access token for the Chariot Production environment, you would use the following URL `https://login.givechariot.com/oauth/token` with Production environment specific OAuth Client Credentials. - - -```curl cURL -curl --request POST \ - --url https://chariot-sandbox.us.auth0.com/oauth/token \ - --header 'content-type: application/json' \ - --data '{"client_id":"CLIENT_ID","client_secret":"CLIENT_SECRET","audience":"https://api.givechariot.com","grant_type":"client_credentials"}' -``` -```csharp C# -var client = new RestClient("https://chariot-sandbox.us.auth0.com/oauth/token"); -var request = new RestRequest(Method.POST); -request.AddHeader("content-type", "application/json"); -request.AddParameter("application/json", "{\"client_id\":\"CLIENT_ID\",\"client_secret\":\"CLIENT_SECRET\",\"audience\":\"https://api.givechariot.com\",\"grant_type\":\"client_credentials\"}", ParameterType.RequestBody); -IRestResponse response = client.Execute(request); -``` -```go Go -package main - -import ( - "fmt" - "strings" - "net/http" - "io/ioutil" -) - -func main() { - - url := "https://chariot-sandbox.us.auth0.com/oauth/token" - - payload := strings.NewReader("{\"client_id\":\"CLIENT_ID\",\"client_secret\":\"CLIENT_SECRET\",\"audience\":\"https://api.givechariot.com\",\"grant_type\":\"client_credentials\"}") - - req, _ := http.NewRequest("POST", url, payload) - - req.Header.Add("content-type", "application/json") - - res, _ := http.DefaultClient.Do(req) - - defer res.Body.Close() - body, _ := ioutil.ReadAll(res.Body) - - fmt.Println(res) - fmt.Println(string(body)) -} -``` -```java Java -HttpResponse response = Unirest.post("https://chariot-sandbox.us.auth0.com/oauth/token") - .header("content-type", "application/json") - .body("{\"client_id\":\"CLIENT_ID\",\"client_secret\":\"CLIENT_SECRET\",\"audience\":\"https://api.givechariot.com\",\"grant_type\":\"client_credentials\"}") - .asString(); -``` -```javascript jQuery -var settings = { - "async": true, - "crossDomain": true, - "url": "https://chariot-sandbox.us.auth0.com/oauth/token", - "method": "POST", - "headers": { - "content-type": "application/json" - }, - "data": "{\"client_id\":\"CLIENT_ID\",\"client_secret\":\"CLIENT_SECRET\",\"audience\":\"https://api.givechariot.com\",\"grant_type\":\"client_credentials\"}" -} - -$.ajax(settings).done(function (response) { - console.log(response); -}); -``` -```javascript NodeJS -var request = require("request"); - -var options = { method: 'POST', - url: 'https://chariot-sandbox.us.auth0.com/oauth/token', - headers: { 'content-type': 'application/json' }, - body: '{"client_id":"CLIENT_ID","client_secret":"CLIENT_SECRET","audience":"https://api.givechariot.com","grant_type":"client_credentials"}' }; - -request(options, function (error, response, body) { - if (error) throw new Error(error); - - console.log(body); -}); -``` -```php PHP -$curl = curl_init(); - -curl_setopt_array($curl, array( - CURLOPT_URL => "https://chariot-sandbox.us.auth0.com/oauth/token", - CURLOPT_RETURNTRANSFER => true, - CURLOPT_ENCODING => "", - CURLOPT_MAXREDIRS => 10, - CURLOPT_TIMEOUT => 30, - CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, - CURLOPT_CUSTOMREQUEST => "POST", - CURLOPT_POSTFIELDS => "{\"client_id\":\"CLIENT_ID\",\"client_secret\":\"CLIENT_SECRET\",\"audience\":\"https://api.givechariot.com\",\"grant_type\":\"client_credentials\"}", - CURLOPT_HTTPHEADER => array( - "content-type: application/json" - ), -)); - -$response = curl_exec($curl); -$err = curl_error($curl); - -curl_close($curl); - -if ($err) { - echo "cURL Error #:" . $err; -} else { - echo $response; -} -``` -```python Python -import http.client - -conn = http.client.HTTPSConnection("chariot-sandbox.us.auth0.com") - -payload = "{\"client_id\":\"CLIENT_ID\",\"client_secret\":\"CLIENT_SECRET\",\"audience\":\"https://api.givechariot.com\",\"grant_type\":\"client_credentials\"}" - -headers = { 'content-type': "application/json" } - -conn.request("POST", "/oauth/token", payload, headers) - -res = conn.getresponse() -data = res.read() - -print(data.decode("utf-8")) -``` -```ruby Ruby -require 'uri' -require 'net/http' - -url = URI("https://chariot-sandbox.us.auth0.com/oauth/token") - -http = Net::HTTP.new(url.host, url.port) -http.use_ssl = true -http.verify_mode = OpenSSL::SSL::VERIFY_NONE - -request = Net::HTTP::Post.new(url) -request["content-type"] = 'application/json' -request.body = "{\"client_id\":\"CLIENT_ID\",\"client_secret\":\"CLIENT_SECRET\",\"audience\":\"https://api.givechariot.com\",\"grant_type\":\"client_credentials\"}" - -response = http.request(request) -puts response.read_body -``` - - -**Response**: - -```json JSON -{ - "access_token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IlBfNkVWSWt0S2p5ZkhNNWdET3RMaSJ9.eyJpc3MiOiJodHRwczovL2NoYXJpb3QtZGV2LnVzLmF1dGgwLmNvbS8iLCJzdWIiOiJXSXpEaWVPaWY4a3Z0T2gxZUlxcGRTaDRUOWtYeFR0MUBjbGllbnRzIiwiYXVkIjoiaHR0cHM6Ly9hcGkuZ2l2ZWNoYXJpb3QuY29tIiwiaWF0IjoxNjc4MzI2MTUwLCJleHAiOjE2Nzg0MTI1NTAsImF6cCI6IldJekRpZU9pZjhrdnRPaDFlSXFwZFNoNFQ5a1h4VHQxIiwic2NvcGUiOiJyZWFkOnVzZXJzIHJlYWQ6dXNlciB1cGRhdGU6dXNlcnMgdXBkYXRlOnVzZXIgZGVsZXRlOnVzZXJzIGRlbGV0ZTp1c2VyIHJlYWQ6bm9ucHJvZml0cyByZWFkOm5vbnByb2ZpdCB1cGRhdGU6bm9ucHJvZml0cyB1cGRhdGU6bm9ucHJvZml0IGRlbGV0ZTpub25wcm9maXRzIGRlbGV0ZTpub25wcm9maXQgbGlzdDpncmFudHMgcmVhZDpncmFudHMgdXBkYXRlOmdyYW50cyBjcmVhdGU6Y29ubmVjdCByZWFkOmNvbm5lY3RzIHJlYWQ6Y29ubmVjdCB1cGRhdGU6Y29ubmVjdHMgdXBkYXRlOmNvbm5lY3QgZGVsZXRlOmNvbm5lY3RzIGRlbGV0ZTpjb25uZWN0IGV4Y2hhbmdlOnRva2VuIGNyZWF0ZTpncmFudHMgY3JlYXRlOnNhbmRib3ggcmVhZDpzYW5kYm94IGNyZWF0ZTpjb25uZWN0cyBsaXN0OmNvbm5lY3RzIGNyZWF0ZTpub25wcm9maXRzIiwiZ3R5IjoiY2xpZW50LWNyZWRlbnRpYWxzIiwicGVybWlzc2lvbnMiOlsicmVhZDp1c2VycyIsInJlYWQ6dXNlciIsInVwZGF0ZTp1c2VycyIsInVwZGF0ZTp1c2VyIiwiZGVsZXRlOnVzZXJzIiwiZGVsZXRlOnVzZXIiLCJyZWFkOm5vbnByb2ZpdHMiLCJyZWFkOm5vbnByb2ZpdCIsInVwZGF0ZTpub25wcm9maXRzIiwidXBkYXRlOm5vbnByb2ZpdCIsImRlbGV0ZTpub25wcm9maXRzIiwiZGVsZXRlOm5vbnByb2ZpdCIsImxpc3Q6Z3JhbnRzIiwicmVhZDpncmFudHMiLCJ1cGRhdGU6Z3JhbnRzIiwiY3JlYXRlOmNvbm5lY3QiLCJyZWFkOmNvbm5lY3RzIiwicmVhZDpjb25uZWN0IiwidXBkYXRlOmNvbm5lY3RzIiwidXBkYXRlOmNvbm5lY3QiLCJkZWxldGU6Y29ubmVjdHMiLCJkZWxldGU6Y29ubmVjdCIsImV4Y2hhbmdlOnRva2VuIiwiY3JlYXRlOmdyYW50cyIsImNyZWF0ZTpzYW5kYm94IiwicmVhZDpzYW5kYm94IiwiY3JlYXRlOmNvbm5lY3RzIiwibGlzdDpjb25uZWN0cyIsImNyZWF0ZTpub25wcm9maXRzIl19.nvRxt8u6Pynevl4H2zoskkZ4xxTwwAhauuE0Tko42vcZ8bSMAOHSQlV3Wvolqy9YIcYgQa9vWJ4BjaD62bBS7dmZJT9KmzV4dOaZV91hFfWY-rcgYQQIWE2RGUv6ptmjGjE2n15-eiPs7fWtPBD4rV7Y5hAkfkDkubtLtxvBhTP8SZZps0lQUoMQf0eKH1jLqdeXAy52Gi5ui25uc1iVB-rUdjLyK6GMO5hfeNMmuSs0rprXhTR9J0jreEL0I2-8lnyIbSSdHhj-tyaUbeVXhUt7ApatcMARAgqqp-anBUi00vux4ePl9O2xN8Lxo0vA5na7C53lken0PyRVCbXAyw", - "scope": "create:nonprofits read:nonprofits create:connects read:connects create:grants read:grants", - "expires_in": 86400, - "token_type": "Bearer" -} -``` - diff --git a/fern/versions/v1.7/pages/api-backend/errors-1.mdx b/fern/versions/v1.7/pages/api-backend/errors-1.mdx deleted file mode 100644 index d25eed1..0000000 --- a/fern/versions/v1.7/pages/api-backend/errors-1.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: "Error Codes" -slug: "errors-1" -subtitle: "" -hidden: false -createdAt: "Wed Jun 01 2022 23:46:21 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Wed Dec 20 2023 02:25:03 GMT+0000 (Coordinated Universal Time)" ---- -The Chariot API uses the standard HTTP status response codes - -| Code | Description | -| :--- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| 400 | Bad Request: The request could not be understood by the server due to malformed syntax. | -| 401 | Unauthorized: The request requires user authentication. The **Authorization** header may be missing or invalid. | -| 403 | Forbidden: The server understood the request but is refusing to fulfill it. The API user does not have correct permissions or the **x-chariot-api-key** header may be missing or invalid. | -| 404 | Not Found: The resource requested does not exist or was not found. | -| 405 | Method Not Allowed: The method/verb specified in the request is not allowed for the resource. | -| 409 | Conflict: The request conflicts with the current state of the target resource. | -| 410 | Gone: Access to the target resource is no longer available as the resource may have expired. | -| 422 | Unprocessable Content: The server cannot process the request due to validation issues | -| 500 | Internal Server Error: The request was valid, but something failed on the server. | -| 502 | Bad Gateway: The server received an invalid response from an upstream server. | -| 503 | Service Unavailable: The server is not ready to handle the request. | - -All error responses come with the following standard shape. - -```json JSON -{ - "timestamp": "2020-07-10 15:00:00.000", - "code": 400, - "error" : "Bad Request", - "message": "a descriptive, yet terse snippet explaining what went wrong" -} -``` - diff --git a/fern/versions/v1.7/pages/api-backend/overview.mdx b/fern/versions/v1.7/pages/api-backend/overview.mdx deleted file mode 100644 index 76fec6f..0000000 --- a/fern/versions/v1.7/pages/api-backend/overview.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "Overview" -slug: "overview" -subtitle: "A comprehensive reference for integrating with Chariot API endpoints" -hidden: false -createdAt: "Wed Jun 01 2022 23:43:34 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Tue Dec 12 2023 22:09:31 GMT+0000 (Coordinated Universal Time)" ---- -The Chariot API is organized around REST. Our API has predictable resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs. - - -If you feel like something is missing from our API docs, feel free to create an **Issue** on our [OpenAPI GitHub repo](https://github.com/chariot-giving/chariot-openapi). - - -## API protocols and headers - -The Chariot API uses standard HTTP response codes to indicate status and errors. All responses come in standard JSON. The Chariot API is served over HTTPS TLS v1.2+ to ensure data privacy; HTTP and HTTPS with TLS versions below 1.2 are not supported. All requests with a payload must include a Content-Type of application/JSON and the body must be valid JSON. - -Every Chariot API response includes a request_id as the `X-Request-Id` header. The request_id is included whether the API request succeeded or failed. For faster support, include the request_id when contacting support regarding a specific API call. - -## API host - -```javascript Server.js -https://sandboxapi.givechariot.com (Sandbox) -https://api.givechariot.com (Production) -``` - -Chariot has two environments: Sandbox and Production. The Sandbox environment supports only test data. All activity in the Production environment is real. When you’re getting ready to launch into production, please let us know by emailing [support@givechariot.com](mailto:support@givechariot.com) to get your production credentials. - diff --git a/fern/versions/v1.7/pages/api-backend/webhooks-and-events.mdx b/fern/versions/v1.7/pages/api-backend/webhooks-and-events.mdx deleted file mode 100644 index 14cb023..0000000 --- a/fern/versions/v1.7/pages/api-backend/webhooks-and-events.mdx +++ /dev/null @@ -1,120 +0,0 @@ ---- -title: "Webhooks and Events" -slug: "webhooks-and-events" -subtitle: "Listen for events on your Chariot account so your platform can automatically trigger reactions." -hidden: false -createdAt: "Tue Jan 23 2024 19:53:12 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Wed Apr 17 2024 17:28:24 GMT+0000 (Coordinated Universal Time)" ---- -When something interesting happens on the nonprofit's Chariot account, such as a Grant being created or its status being updated, Chariot can send a message to your application so that you can take action automatically. - -The first step is to create an Event Subscription via the [API](/api-reference/event-subscriptions/create). As part of this, you specify a URL for a server endpoint that will receive real-time events. Chariot will then send HTTPS requests to that URL to notify you of activity for certain events. - -When a noteworthy event happens, Chariot first generates an [Event](/api-reference/events/get). Next, we'll send a POST request to your endpoint. The body of the POST request will be the same as the API representation of the Event, such as: - -```json event.json -{ - "id": "event_123abc", - "created_at": "2023-01-31T23:59:59Z", - "category": "grant.created", - "associated_object_type": "grant", - "associated_object_id": "67d66b89-51a0-4f17-a7b3-18c5dbac5361" -} - -``` - -Note that you can create Event Subscriptions in Production and Sandbox. Sandbox Event Subscriptions will receive events for Sandbox events and vice versa. - -## Consuming Events - -Individual Events don’t contain very much information on their own. This is by design, as the API structure can remain extremely stable and avoid difficult webhook migrations in the future as the Chariot API changes. If you need additional metadata, such as the amount or status of the Grant in the above example, make a GET request to the API for that information. - -If you don't want to use webhooks, or need to do some batch processing, you can also request Events from the Chariot API using the [List Events API](/api-reference/events/list). Events will remain in the Chariot system for up to 30 days. - -### Event Types - -These events represent specific occurrences within our system that you can subscribe to and receive notifications for. - -- `grant.created`: This event is triggered when a grant is created. -- `grant.updated`: This event is triggered when a grant is updated. This can happen when the status changes for example. -- `unintegrated_grant.created`: This event is triggered when an unintegrated grant is created. -- `unintegrated_grant.updated`: This event is triggered when an unintegrated grant is updated. - -## Secure your webhooks - -After you've confirmed that your webhook endpoint connections works as expected, secure the connection by verifying the signature provided in the header of the webhook request. - - -In order to verify signatures for webhooks, you need to specify the signing secret that you will use in the [Create Event Subscription API](/api-reference/event-subscriptions/create). - - -Chariot will include the `Chariot-Webhook-Signature` header in each webhook request. This header will contain a timestamp and one or more signatures. The timestamp is prefixed by `t=`, and each signature is prefixed by a scheme. Schemes start with `v`, followed by an integer. Currently, the only valid live signature scheme is `v1`. - -``` -Chariot-Webhook-Signature: t=2024-01-19T18:48:56Z,v1=e0632fb61f7d1068ecbde75410d5c3cc152926f97eaacf53c6228624647329da -``` - -Chariot generates signatures using a hash-based message authentication code ([HMAC](https://en.wikipedia.org/wiki/HMAC)) with [SHA-256](https://en.wikipedia.org/wiki/SHA-2). To prevent [downgrade attacks](https://en.wikipedia.org/wiki/Downgrade_attack), ignore all schemes that are not v1. - -### Verify Signatures Manually - -#### Step 1: Extract the timestamp and signatures from the header - -Split the header using the `,` character as the separator to get a list of elements. Then split each element using the `=` character as the separator to get a prefix and value pair. - -The value for the prefix `t` corresponds to the timestamp, and `v1` corresponds to the signature. You can discard all other elements. - -#### Step 2: Prepare the signed payload - -The `signed_payload` string is created by concatenating: - -- The timestamp (as a string) -- The character `.` -- The actual JSON payload (that is, the request body) - -#### Step 3: Determine the expected signature - -Compute an HMAC with the SHA256 hash function. Use the Event Subscription's `signingSecret` as the key, and use the `signed_payload` string as the message. - -#### Step 4: Compare the Signatures - -Compare the signature (or signatures) in the header to the expected signature. For an equality match, compute the difference between the current timestamp and the received timestamp, then decide if the difference is within your tolerance. - -To protect against timing attacks, use a constant-time-string comparison to compare the expected signature to each of the received signatures. - -## Failures and Retries - -In production, if your application returns anything other than a 20x HTTP status code, we’ll retry it up to 10 times with exponentially increasing backoffs. In your webhook endpoint implementation, we recommend you place inbound Events into your application’s own queuing system for asynchronous event processing, and return a 200 response from your endpoint as quickly as possible. Because we can't guarantee we'll receive your 200 acknowledgement, your webhook implementation should gracefully handle receiving the same webhook multiple times. - -To avoid queueing issues, we will not retry failed webhooks in the sandbox. - - -If all attempts to a webhook endpoint fail, after 5 days the endpoint will be disabled and we will stop sending event messages to that endpoint. - - -## Best Practices - -Review these best practices to make sure your webhooks remain secure and function well with your integration. - -### Handle Duplicate Events - -Webhook endpoints might occasionally receive the same event more than once. You can guard against duplicated event receipts by making your event processing idempotent. - -### Only subscribe to event categories your integration requires - -Configure your webhook endpoints to receive only the types of events required by your integration. Listening for extra events (or all events) puts undue strain on your server and we don’t recommend it. - -You can [Update an Event Subscription](/api-reference/event-subscriptions/update) to change the event category for a webhook endpoint with the API. - -### Receive events with an HTTPS server - -If you use an HTTPS URL for your webhook endpoint, Chariot validates that the connection to your server is secure before sending your webhook data. For this to work, your server must be correctly configured to support HTTPS with a valid server certificate. The Production environment requires HTTPS URLs. - -### Quickly return a 2xx response - -Your endpoint must quickly return a successful status code (2xx) prior to any complex logic that could cause a timeout. - -### Verify webhook signatures - -See the section above on [verifying webhook signatures](/webhooks-and-events#secure-your-webhooks) - diff --git a/fern/versions/v1.7/pages/chariot-api/grants-1/create-grant.mdx b/fern/versions/v1.7/pages/chariot-api/grants-1/create-grant.mdx deleted file mode 100644 index 5c52d94..0000000 --- a/fern/versions/v1.7/pages/chariot-api/grants-1/create-grant.mdx +++ /dev/null @@ -1,16 +0,0 @@ ---- -title: "Create Grant" -slug: "create-grant" -subtitle: "Create a grant from a workflow session. This is useful to capture a grant intent from an authorized connect workflow session and submit the grant request.\nThe grant must be captured within 5 minutes of authorization otherwise the request will return status 410 Gone.\nA grant can only be captured once from any given workflow session so any duplicate requests will return status 409 Conflict.\nThe grant amount must be in whole dollar increments (rounded to the nearest hundred) as currently DAFs only accept whole dollar grants.\nThe grant amount must be greater than or equal to the minimum grant amount for the DAF otherwise the request will return status 400 Bad Request.\nThe grant amount must be less than or equal to the user's DAF account balance otherwise the request will return status 400 Bad Request." -hidden: false -createdAt: "Fri Nov 11 2022 21:12:48 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Fri Jan 26 2024 19:37:55 GMT+0000 (Coordinated Universal Time)" ---- -This is useful to capture a grant intent from an authorized Connect workflow session and submit the grant request. A grant can only be captured once from any given workflow session so any duplicate requests will return status 409 Conflict. - -The grant amount must be in whole dollar increments (rounded to the nearest hundred) as currently DAFs only accept whole dollar grants. The grant 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 grant amount must be less than or equal to the user's DAF account balance otherwise the request will return status 400 Bad Request. - - -Generally grants should be captured as soon as possible after a grant intent is authorized by a user to optimize for conversion. We recommend a soft limit of 5 minutes and enforce a hard limit of 15 minutes. This means that after 5 minutes, there's a higher chance of an error and after 15 minutes, the request will return status 410 Gone. - - diff --git a/fern/versions/v1.7/pages/connect-frontend/button-styles.mdx b/fern/versions/v1.7/pages/connect-frontend/button-styles.mdx deleted file mode 100644 index 7413931..0000000 --- a/fern/versions/v1.7/pages/connect-frontend/button-styles.mdx +++ /dev/null @@ -1,92 +0,0 @@ ---- -title: "Button Styles" -slug: "button-styles" -subtitle: "Provided styles for the Chariot Connect button" -hidden: false -createdAt: "Mon Feb 20 2023 16:24:01 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Thu Feb 15 2024 17:21:29 GMT+0000 (Coordinated Universal Time)" ---- -# Using a default theme - -Choose your theme by adding the theme name as a parameter to the `chariot-connect` modal, as below. - - -```html HTML - -> - -``` -```javascript React - - ... -/> -``` - - -We provide the options below as default themes. If `theme` is not defined, `DefaultTheme` will be used. - -## `DefaultTheme` - - - - -## `LightModeTheme` - - - - -## `LightBlueTheme` - - - - -## `GradientTheme` - - - - -# Creating a custom theme - -To create a custom theme for the Chariot Connect button, create an object with the desired properties that you wish to change. Utilize [Tailwind CSS](https://tailwindcss.com/) styling in the definition of these properties. - - - Style customizations for Chariot Connect require that all available CSS be packaged within the `chariot-connect.umd.js` bundle. The problem is that for Chariot to allow any customizations, we would need to include the entire [tailwindcss](https://v1.tailwindcss.com/docs/controlling-file-size) package (~2.4Mb uncompressed) which would degrade performance and load times to an unacceptable level. While performance is a concern, we also realize the need for a consistent and seamless user experience and are also committed to providing configurations for size, padding, border radius, etc. on top of the pre-built themes that we offer. - - -```javascript JavaScript -// get the element from the DOM -const chariot = document.getElementById("chariot") - -// define your alterations using valid properties from the table below -const alterations = { - width: "w-12", - height: "h-8", -}; - -// register your new theme with a custom name -chariot.registerTheme("myTheme", alterations); -``` -```javascript React - -``` - -### Theme Properties - -| Parameter Name | Use | Allowed value | -| :----------------- | :--------------------------------------------------------------------------------------- | :---------------------------------------------------------------------------------------- | -| `width` | The width of the button | [width](https://tailwindcss.com/docs/width) up to `16` or `64px` | -| `height` | The height of the button | [height](https://tailwindcss.com/docs/height) at least `9` or `36px` up to `12` or `48px` | -| `showExtendedText` | Show an extended text (`Give with Donor Advised Fund`) version of the DAFpay button text | `true` or `false` (this value is `false` by default) | - diff --git a/fern/versions/v1.7/pages/connect-frontend/configurations.mdx b/fern/versions/v1.7/pages/connect-frontend/configurations.mdx deleted file mode 100644 index 97e4a63..0000000 --- a/fern/versions/v1.7/pages/connect-frontend/configurations.mdx +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: "Workflow Configurations" -slug: "configurations" -subtitle: "" -hidden: false -createdAt: "Mon Dec 18 2023 21:56:47 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Tue Mar 05 2024 21:53:28 GMT+0000 (Coordinated Universal Time)" ---- -Chariot allows for a couple of workflow configurations. To change any of the default configurations, please email [support@givechariot.com](mailto:support@givechariot.com) - -### Disable unintegrated grant submissions - - - - -If a user selects an unintegrated DAF, the workflow can be configured to prompt closing the modal and selecting another payment option (see image above). This option is typically chosen if users prefer to avoid redirection away from the page to complete the gift elsewhere. - -### Donate versus Continue - - - - -In the final pane of the workflow, the call-to-action button can be configured to show "Continue" instead of "Donate" (refer to the image above). Those preferring their users to input additional information after the Connect experience choose to alter the button to "Continue". - -### Autofill Donor Information - -The Chariot Connect modal has the ability to pull information about the donor from their account with the DAF provider. If this feature is enabled, the donor information will be pre-populated in the last pane of the workflow as long as no donor information was passed into Connect via the `onDonationRequest` callback. The user always has the ability to review their information and make changes before submission. This allows for "one-click" checkout experiences and removes the need for a donor to fill out a lengthy form before making a DAF donation. - -Chariot makes no guarantee on the completeness or consistency of the information fetched from the donor's DAF account and serves purely as a convenience feature for donors to expedite the donation experience. In general, Chariot supports fetching donor name, email, and address information. If you require certain information from donors, you will likely need to use the "Continue" flow mentioned above and you can analyze the donor data passed back from the `CHARIOT_SUCCESS` callback and determine if more information is needed before creating the Grant and finalizing the donation. - diff --git a/fern/versions/v1.7/pages/connect-frontend/integrating-connect.mdx b/fern/versions/v1.7/pages/connect-frontend/integrating-connect.mdx deleted file mode 100644 index 54bd8bf..0000000 --- a/fern/versions/v1.7/pages/connect-frontend/integrating-connect.mdx +++ /dev/null @@ -1,242 +0,0 @@ ---- -title: "Integrating Connect (DAFpay)" -slug: "integrating-connect" -subtitle: "Reference for initializing DAFpay using React or JavaScript SDK" -hidden: false -createdAt: "Fri Feb 17 2023 18:02:35 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Fri Apr 12 2024 17:08:43 GMT+0000 (Coordinated Universal Time)" ---- - - **Enable by Default**: DAFpay supports transactions for all eligible 501(c)(3) organizations, allowing DAFpay to function on a donation form prior to the completion of the nonprofit's onboarding with Chariot. Thus, we advise setting DAFpay as a default payment option across your donation pages. This will improve fundraising outcomes and help develop relationships with key donors! - - **Express Checkout Option**: DAFpay offers the capability to automatically gather crucial donor information, such as names, email addresses, physical addresses, and more. Additionally, DAFpay provides Intelligent Donation Recommendations, taking into account factors like the donor's account balance. For this reason, we recommend featuring DAFpay as an Express Checkout option, making it visible early in the donation process, before donors are prompted to input their information or decide on a donation amount. This enhances conversion rates and encourages larger donations. - - Please don't hesitate to contact us with any questions! - - -## Installation - -Chariot Connect (DAFpay button) comes as a small JavaScript package. It can be loaded directly from the Chariot CDN or installed via [NPM](https://www.npmjs.com/package/react-chariot-connect) or Yarn. When loading from the CDN, It must always be loaded directly from [https://cdn.givechariot.com](https://cdn.givechariot.com), rather than included in a bundle or hosted yourself. - - -```html CDN - -``` -```shell NPM -npm install --save react-chariot-connect -``` -```shell Yarn -yarn add react-chariot-connect -``` - - -## Add Chariot Connect - -Chariot provides a simple-to-use web component that allows you to implement the Chariot Connect (DAFpay) button with a single line. Add Chariot-Connect component where you want the DAFpay button to appear. - - -```html HTML - -``` -```javascript React -import React, { useState } from 'react'; -import ChariotConnect from 'react-chariot-connect'; - -const App = () => { - return ( -
- -
- ); -}; -``` - - -A nonprofit's `cid` (Connect ID) should be retrieved from your database after the nonprofit has been registered with Chariot. For now, feel free to use this cid for testing purposes: `test_15b867c559e3c73a80cd69efd115cb928cb9874625291f756f7273446bcd8f88`. - -
- -_Note: For testing purposes in a sandbox environment the following credentials will log in to any DAF provider._ - -``` -username: good-user -password: password123 -``` - -## Pre-populate data into your Connect Session - -Chariot accepts information before it launches a Connect session. To provide this information, leverage the `onDonationRequest` function from the Chariot element. As suggested above, pre-populating this information is completely optional, however you can use metadata if you want to associate the payment or session with any data in your system. - - -```javascript JavaScript -// get the element from the DOM -const chariot = document.getElementById("chariot") - -// provide a callback that returns the donation data -chariot.onDonationRequest(async () => { - return { - amount: 25000, //this is $250.00 USD - firstName: "Michael", - lastName: "Scott", - email: "michaelScott@theoffice.com", - metadata: { - fundraiserTag: "marathon" - }, - } -}) -``` -```javascript React -import React, { useState } from 'react'; -import ChariotConnect from 'react-chariot-connect'; - -const App = () => { - const onDonationRequest = () => { - return { - amount: 25000, //this is $250.00 USD - firstName: "Michael", - lastName: "Scott", - email: "michaelScott@theoffice.com", - metadata: { - fundraiserTag: "marathon" - }, - } - } - - return ( -
- -
- ); -}; -``` - - -The given donation data must match the following schema to be accepted by Chariot: - -| Parameter | Description | Type | -|------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------| -| amount | The donation amount in cents. e.g., for a $20 donation, enter 2000.

If this value is not passed in, Chariot will use the user's account balance to recommend a donation amount. This can lead to significantly larger donation amounts. | number (optional) | -| firstName | The donor's first name | string (optional) | -| lastName | The donor's last name | string (optional) | -| email | The donor's email address. Must be in email format | string (optional) | -| phone | The donor's phone number. Please provide the phone number with the country code and without special characters | string (optional) | -| note | A note the donor wants to send to the nonprofit | string (optional) | -| anonymous | Indicates if this donation should be sent anonymously (default: false) | boolean (optional)| -| metadata | An object with a set of name-value pairs. You can use this object to include any miscellaneous information you want to tie to the workflow session. | object (optional) | - -## Capture your grant intent - -When a user completes a Chariot Connect session you will receive a grant intent. After you submit your own donation form, don't forget to call the [ Create Grant](/api-reference/grants/create) API to complete the transaction. - -Most workflows proceed as follows: - -1. Listen for the `CHARIOT_SUCCESS` event to receive the grant intent after a Chariot Connect session. - 1. If you would like to collect any additional information from the user such as additional contact information you can do so at this step. If the Chariot Connect session is the last step in your donation form this is not necessary. -2. Submit your own donation form before converting the grant intent into a completed grant. - _Note: Submitting your own donation form before converting the grant ensures consistency between your systems and Chariot._ -3. Have your backend call Chariot's [Create Grant](/api-reference/grants/create) API to complete the grant (and capture the grant intent). - - -```javascript JavaScript -// get the element from the DOM -const chariot = document.getElementById('chariot'); - -chariot.addEventListener('CHARIOT_SUCCESS', ({ detail }) => { - // Record the grant intent information so that you can - // capture the transaction once your form is submitted. -}); -``` -```javascript React -import React, { useState } from 'react'; -import ChariotConnect from 'react-chariot-connect'; - -const App = () => { - const onSuccess = (r) => { - // Record the grant intent information so that you can - // complete the transaction once your form is submitted. - }; - const onExit = (e) => console.log('exit', e); - const onDonationRequest = () => { - // your logic - } - - return ( -
- -
- ); -}; -``` - - -### Response Objects - - -```json onSuccessMetadata -{ - "workflowSessionId":"79e772be-547d-4c9c-8b76-4ac4ed4c441a", //Id of the Connect session - "grantIntent": { - "userFriendlyId": "100020", //The user-friendly identifier for the grant intent - "fundId": "bbf485dd-a056-4a9d-89a8-06e201cdbf7f", //Id of the donor advised fund - "amount": 2000, //The grant amount expressed in units of cents; USD only - "metadata": {} // The same metadata object that was passed in the onDonationRequest callback referenced above - } - -``` -```json onExitMetadata -{ - "workflowSessionId": "79e772be-547d-4c9c-8b76-4ac4ed4c441a", // Id of the Connect workflow session. - "nodeId": "consent-node-id", // The id representing the pane where the user exited the Connect flow. - "fundId": "bbf485dd-a056-4a9d-89a8-06e201cdbf7f", // The id of the donor advised fund that the user selected. - "reason": "USER_EXIT", // An enum giving a reason to why the modal exited. - "description": "User exited the flow" // A human readable string containing a brief sentence explaining the exit reason. -} -``` - -| Event Name | Description | Metadata Type | -|--------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------| -| `CHARIOT_INIT` | The init event is called when the Chariot Connect script is initialized and ready to be run. This is useful to be able to know when Chariot Connect is initialized and ready to be used. | No metadata is provided for this event. | -| `CHARIOT_SUCCESS` | The success event contains a final summary of the Connect workflow session. It contains the workflow session id and relevant donation information.

Once you receive the success event don't forget to complete the transaction by calling the [Create Grant](/api-reference/grants/create) route. | `OnSuccessMetadata` | -| `CHARIOT_EXIT` | The exit event is called when a user exits without successfully completing the flow, when an error occurs during the flow, or when a user confirms an unintegrated grant. | `OnExitMetadata` | - - -#### Exit Reasons - -```javascript JavaScript -enum ExitReason { - USER_EXIT = "USER_EXIT", // User exited the flow - UNINTEGRATED_DAF = "UNINTEGRATED_DAF", // DAF is not integrated with Chariot - UNINTEGRATED_GRANT_CONFIRMED = "UNINTEGRATED_GRANT_CONFIRMED", // Unintegrated grant confirmed with Chariot - CID_NOT_FOUND = "CID_NOT_FOUND", // Connect Identifier is not found - CREDENTIALS_ERROR = "CREDENTIALS_ERROR", // Invalid credentials - INVALID_CARD = "INVALID_CARD", // Invalid card number - TFA_ERROR = "TFA_VERIFICATION_ERROR", // Two-factor authentication error - ZERO_AMOUNT = "ZERO_GRANT_AMOUNT", // Grant amount is zero - SERVICE_DEACTIVATED = "SERVICE_DEACTIVATED", // Nonprofit's Connect is deactivated (active = false) - ACCESS_RESTRICTED = "ACCOUNT_ACCESS_RESTRICTED", // User's DAF sponsor account electronic access is restricted - EIN_NOT_FOUND = "NONPROFIT_NOT_FOUND", // DAF sponsor does not support grants to the Nonprofit - CONNECTION_FAILED = "CONNECTION_FAILED", // Connection to the DAF sponsor failed - SESSION_NOT_FOUND = "SESSION_NOT_FOUND", // User session is not found and may have expired - CUSTOM_ERROR = "CUSTOM_ERROR", // Custom error - INTERNAL_ERROR = "INTERNAL_ERROR", // Internal error - INSTITUTION_DOWN_ERROR = "INSTITUTION_DOWN_ERROR", // DAF sponsor institution is down; user should try again later -} -``` - - -## Advanced Customizations - -### Disabling Chariot Connect - -To prevent Connect from initiating until form validation is performed, passing `false` to the onDonationRequest will stop the button from launching. - diff --git a/fern/versions/v1.7/pages/getting-started/faq.mdx b/fern/versions/v1.7/pages/getting-started/faq.mdx deleted file mode 100644 index c89b2ce..0000000 --- a/fern/versions/v1.7/pages/getting-started/faq.mdx +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: "FAQ" -slug: "faq" -subtitle: "Answers to commonly asked questions" -hidden: false -createdAt: "Mon Dec 18 2023 20:30:30 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Wed Mar 27 2024 18:04:44 GMT+0000 (Coordinated Universal Time)" ---- -### How can my platform collect our processing fees? - -In the [Create Grant](/api-reference/grants/create) endpoint, there is a parameter named `applicationFeeAmount`. This will allow the caller to pass in a processing fee for the grant. Chariot will then either deduct that amount before paying out the nonprofit or invoice the fees from the Nonprofit and send the fees in a cadence according to an agreed-upon contract. - -### How can I run form validations before the Connect button launches? - -To perform form validation before Chariot Connect launches, simply return `false` in the onDonationRequest. Please see [Integrating Connect](/integrating-connect) to learn more. - -### How can donors cover fees? - -If a donor wishes to cover the fees, increase the final amount sent to the [Create Grant](/api-reference/grants/create) route to compensate for the processing fees. Take into consideration that increasing the final amount also raises the processing fee and **don't forget to round the final amount to a whole dollar (nearest 100) as DAFs only allow grants in dollar increments**. - -To calculate the final amount you can use the following formula: - - - - -### What is the DAFpay Network? - -For nonprofits that haven't completed onboarding and verification with Chariot, DAFpay routes payments through a 501(c)(3) nonprofit entity named [DAFpay Network](https://www.dafpaynetwork.org/). The DAFpay Network then sends the funds to the nonprofit minus processing fees. This enables DAFpay to accommodate payments to all eligible 501(c)(3) nonprofits for receiving DAF (Donor-Advised Fund) donations. - - - diff --git a/fern/versions/v1.7/pages/getting-started/how-chariot-works.mdx b/fern/versions/v1.7/pages/getting-started/how-chariot-works.mdx deleted file mode 100644 index dcd3aed..0000000 --- a/fern/versions/v1.7/pages/getting-started/how-chariot-works.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: "Overview" -slug: "how-chariot-works" -subtitle: "A quick introduction to integrating DAFpay" -hidden: false -createdAt: "Sun May 21 2023 20:36:07 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Wed May 01 2024 21:30:05 GMT+0000 (Coordinated Universal Time)" ---- - - - -# Introduction - -DAFpay is a payment option that enables donors to complete transactions using their Donor-Advised Fund (DAF). - -### Features and Advantages of DAFpay: - -1. **Universal Support for Nonprofits**: DAFpay enables donors to support any nonprofit organization eligible to receive DAF gifts, thus facilitating grants to a wide range of eligible nonprofits. -2. **Express Checkout**: By retrieving donor information automatically, DAFpay eliminates the need for donors to enter their contact details on donation forms, thereby simplifying the donation process and enhancing conversion rates. For most scenarios, DAFpay can auto-fill details such as the donor's name, email, address, and phone number. -3. **Intelligent Donation Recommendations**: DAFpay suggests donation amounts calculated from the donor's account balance and other key factors, encouraging larger donations. On average, donations made through DAFpay exceed $1,000. - -DAFpay manages the entire grant submission process, including credential verification, multi-factor authentication, error management, and fee collection, for each Donor Advised Fund supported. - -## How it works - -The initial step involves **registering** each nonprofit organization. Once registered, you will receive a Connect ID (CID) that can be used to **initialize** Connect, the web component that renders the DAFpay button. Lastly, **query** Chariot's APIs to gather all the data generated through Connect. - - - - -## Try it out! - -Try out the [Chariot Demo](https://app.givechariot.com/demo) for yourself and see what it might look like on your website after you've completed the integration. - diff --git a/fern/versions/v1.7/pages/getting-started/quickstart.mdx b/fern/versions/v1.7/pages/getting-started/quickstart.mdx deleted file mode 100644 index bd70e37..0000000 --- a/fern/versions/v1.7/pages/getting-started/quickstart.mdx +++ /dev/null @@ -1,182 +0,0 @@ ---- -title: "Quick Start" -slug: "quickstart" -subtitle: "" -hidden: false -createdAt: "Wed Jan 04 2023 20:44:11 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Wed Mar 27 2024 22:59:22 GMT+0000 (Coordinated Universal Time)" ---- -This guide will help you get up and running making your first Chariot API call in just a few minutes. You will create an access token, get a CID for a nonprofit, and query for the grants of that CID. - - -This guide assumes you have already been shared a `client_id` and `client_secret`. If that is not the case, please email [support@givechariot.com](mailto:support@givechariot.com). - - -## 1. Generate an access token 🔑 - -First, you'll need to create an access token that lets you access the APIs. Fill in the provided client_id and client_secret to in the preferred code snippet and get an access token. - - -```curl cURL -curl --request POST \ - --url 'https://chariot-sandbox.us.auth0.com/oauth/token' \ - --header 'content-type: application/x-www-form-urlencoded' \ - --data 'audience=https://api.givechariot.com&grant_type=client_credentials&client_id=YOUR_CLIENT_ID&client_secret=YOUR_CLIENT_SECRET' -``` -```http HTTP -POST https://chariot-sandbox.us.auth0.com/oauth/token -Content-Type: application/x-www-form-urlencoded - -audience=https://api.givechariot.com&grant_type=client_credentials&client_id=YOUR_CLIENT_ID&client_secret=YOUR_CLIENT_SECRET -``` -```javascript JavaScript -var request = require("request"); - -var options = { method: 'POST', - url: 'https://chariot-sandbox.us.auth0.com/oauth/token', - headers: { 'content-type': 'application/x-www-form-urlencoded' }, - form: - { client_id: 'YOUR_CLIENT_ID', - client_secret: 'YOUR_CLIENT_SECRET', - audience: 'https://api.givechariot.com', - grant_type: 'client_credentials' } - }; - -request(options, function (error, response, body) { - if (error) throw new Error(error); - - console.log(body); -}); -``` - - -## 2. Create a CID for a nonprofit 🪪 - -Now that you have an access token, you're set to initiate an API request. We're going to utilize Chariot's APIs to generate a CID (Connect Identifier) for a nonprofit organization. This CID is a crucial element needed to activate the DAFpay button. - -To create a CID to a nonprofit, we first establish the nonprofit's ID by utilizing their EIN (Employer Identification Number). Following that, we proceed to create a Connect with the nonprofit's ID. - -### 2a. Create Nonprofit :hospital: - -The [Create nonprofit](/api-reference/nonprofits/create) endpoint registers a new nonprofit or confirms its existence within the Chariot system. - -For registration, it's necessary to supply the nonprofit's EIN and details for a contact person at the nonprofit for Chariot's customer support purposes. - -Below are a few examples of different implementations. Modify the `user` object, `ein` field, and access token from step 1 before making the request. - - -```curl cURL -curl --request POST \ - --url https://sandboxapi.givechariot.com/v1/nonprofits \ - --header 'accept: application/json' \ - --header 'authorization: Bearer ACCESS_TOKEN' \ - --header 'content-type: application/json' \ - --data ' -{ - "user": { - "email": "hansolo@savethestars.com", - "phone": "3051234321", - "firstName": "Han", - "lastName": "Solo" - }, - "ein": "123456789" -} -' -``` -```javascript JavaScript -const options = { - method: 'POST', - headers: { - accept: 'application/json', - 'content-type': 'application/json', - authorization: 'Bearer ' - }, - body: JSON.stringify({ - user: { - email: 'hansolo@savethestars.com', - phone: '3051234321', - firstName: 'Han', - lastName: 'Solo' - }, - ein: '123456789' - }) -}; - -fetch('https://sandboxapi.givechariot.com/v1/nonprofits', options) - .then(response => response.json()) - .then(response => console.log(response)) - .catch(err => console.error(err)); -``` - - -Bravo! You have just created a nonprofit in the Chariot system. Mark down the nonprofit's `id` and now let's create a Connect for this nonprofit. - -### 2b. Create Connect 🪪 - -The [Create Connect](/api-reference/connects/create) endpoint creates a Connect record or retrieves it if a Connect already exists for this nonprofit in Chariot's system. - -To create a Connect, the nonprofit's `id` must be provided, which you should have from the previous step! - -Below are a few examples of different implementations. Modify the `NONPROFIT_ID` query parameter with the nonprofit's `id`. Don't forget to add the access_token! - - -```curl cURL -curl --request POST \ - --url 'https://sandboxapi.givechariot.com/v1/connects?nonprofit=NONPROFIT_ID' \ - --header 'accept: application/json' \ - --header 'authorization: Bearer ACCESS_TOKEN' \ - --header 'content-type: application/json' -``` -```javascript JavaScript -const options = { - method: 'POST', - headers: { - accept: 'application/json', - 'content-type': 'application/json', - authorization: 'Bearer YOUR_TOKEN_FROM_STEP_1_HERE' - } -}; - -fetch('https://sandboxapi.givechariot.com/v1/connects?nonprofit=NONPROFIT_ID', options) - .then(response => response.json()) - .then(response => console.log(response)) - .catch(err => console.error(err)); -``` - - -Amazing! You can now start [Integrating Connect](integrating-connect) to build a front end and start receiving grants for this nonprofit. - -## 3. List Grants 💵 - -After submitting several grants through Chariot Connect, you can access Chariot's APIs to retrieve information on those grants. - -The [List Grants](/api-reference/grants/list) endpoint lists all the grants for a particular CID. - -To retrieve grants, you must supply the API key of the Connect. You can obtain the API Key by using the [Get Connect](/api-reference/connects/get)endpoint or by noting it down from the setup process when you initially created the Connect. - -Now we are ready to list grants. Below are a few examples of different implementations. Modify the `API_KEY` with the Connect's API key. Don't forget to add the access_token! - - -```curl cURL -curl --request GET \ - --url 'https://sandboxapi.givechariot.com/v1/grants?pageLimit=10' \ - --header 'accept: application/json' \ - --header 'authorization: Bearer ACCESS_TOKEN' \ - --header 'x-chariot-api-key: API_KEY' -``` -```javascript JavaScript -const options = { - method: 'GET', - headers: { - accept: 'application/json', - authorization: 'Bearer YOUR_TOKEN_FROM_STEP_1_HERE', - 'x-chariot-api-key': 'API_KEY' - } -}; - -fetch('https://sandboxapi.givechariot.com/v1/grants?pageLimit=10', options) - .then(response => response.json()) - .then(response => console.log(response)) - .catch(err => console.error(err)); -``` - diff --git a/fern/versions/v1.8/docs.yml b/fern/versions/v1.8/docs.yml deleted file mode 100644 index d1670e7..0000000 --- a/fern/versions/v1.8/docs.yml +++ /dev/null @@ -1,45 +0,0 @@ -navigation: - - section: Documentation - contents: - - section: Getting Started - contents: - - page: Overview - path: ./pages/getting-started/how-chariot-works.mdx - - page: Quick Start - path: ./pages/getting-started/quickstart.mdx - - page: Navigating the Docs - path: ./pages/getting-started/navigating-the-docs.mdx - - page: FAQ - path: ./pages/getting-started/faq.mdx - - section: Connect (FRONTEND) - contents: - - page: Integrating Connect (DAFpay) - path: ./pages/connect-frontend/integrating-connect.mdx - - page: Button Styles - path: ./pages/connect-frontend/button-styles.mdx - - page: Workflow Configurations - path: ./pages/connect-frontend/configurations.mdx - - page: Error Handling & Edge Cases - path: ./pages/connect-frontend/error-handling-1.mdx - - section: API (BACKEND) - contents: - - page: Overview - path: ./pages/api-backend/overview.mdx - - page: Authentication - path: ./pages/api-backend/authentication-1.mdx - - page: Error Codes - path: ./pages/api-backend/errors-1.mdx - - page: Grant Statuses - path: ./pages/api-backend/grant-statuses.mdx - - page: Postman - path: ./pages/api-backend/postman.mdx - - page: Webhooks and Events - path: ./pages/api-backend/webhooks-and-events.mdx - - api: API Reference - display-errors: true - snippets: - typescript: chariot - layout: - - auth - - DAFs: - title: Donor Advised Funds \ No newline at end of file diff --git a/fern/versions/v1.8/images/15e7e65-Error-handling-picture.png b/fern/versions/v1.8/images/15e7e65-Error-handling-picture.png deleted file mode 100644 index 8345dca..0000000 Binary files a/fern/versions/v1.8/images/15e7e65-Error-handling-picture.png and /dev/null differ diff --git a/fern/versions/v1.8/images/36d8373-dafpay-auth.png b/fern/versions/v1.8/images/36d8373-dafpay-auth.png deleted file mode 100644 index b7c9422..0000000 Binary files a/fern/versions/v1.8/images/36d8373-dafpay-auth.png and /dev/null differ diff --git a/fern/versions/v1.8/images/41e910d-Group_549.png b/fern/versions/v1.8/images/41e910d-Group_549.png deleted file mode 100644 index 8ea0662..0000000 Binary files a/fern/versions/v1.8/images/41e910d-Group_549.png and /dev/null differ diff --git a/fern/versions/v1.8/images/446fbf1-Gradient.svg b/fern/versions/v1.8/images/446fbf1-Gradient.svg deleted file mode 100644 index ee489e1..0000000 --- a/fern/versions/v1.8/images/446fbf1-Gradient.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/fern/versions/v1.8/images/57a9b45-api-manual-graphic.png b/fern/versions/v1.8/images/57a9b45-api-manual-graphic.png deleted file mode 100644 index 2418f9a..0000000 Binary files a/fern/versions/v1.8/images/57a9b45-api-manual-graphic.png and /dev/null differ diff --git a/fern/versions/v1.8/images/68157f8-lagrida_latex_editor.png b/fern/versions/v1.8/images/68157f8-lagrida_latex_editor.png deleted file mode 100644 index 45dd1ba..0000000 Binary files a/fern/versions/v1.8/images/68157f8-lagrida_latex_editor.png and /dev/null differ diff --git a/fern/versions/v1.8/images/8155407-DefaultTheme.svg b/fern/versions/v1.8/images/8155407-DefaultTheme.svg deleted file mode 100644 index 063b2b3..0000000 --- a/fern/versions/v1.8/images/8155407-DefaultTheme.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/fern/versions/v1.8/images/9339d40-Connect-no-words.png b/fern/versions/v1.8/images/9339d40-Connect-no-words.png deleted file mode 100644 index cc052f3..0000000 Binary files a/fern/versions/v1.8/images/9339d40-Connect-no-words.png and /dev/null differ diff --git a/fern/versions/v1.8/images/9c06770-LightBlue.svg b/fern/versions/v1.8/images/9c06770-LightBlue.svg deleted file mode 100644 index 8a73fd0..0000000 --- a/fern/versions/v1.8/images/9c06770-LightBlue.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/fern/versions/v1.8/images/a080c51-api_doc_image.png b/fern/versions/v1.8/images/a080c51-api_doc_image.png deleted file mode 100644 index 09fb77f..0000000 Binary files a/fern/versions/v1.8/images/a080c51-api_doc_image.png and /dev/null differ diff --git a/fern/versions/v1.8/images/a750cf5-API_Docs_Overview_Diagram.png b/fern/versions/v1.8/images/a750cf5-API_Docs_Overview_Diagram.png deleted file mode 100644 index cff27ae..0000000 Binary files a/fern/versions/v1.8/images/a750cf5-API_Docs_Overview_Diagram.png and /dev/null differ diff --git a/fern/versions/v1.8/images/a7b65c5-LightMode.svg b/fern/versions/v1.8/images/a7b65c5-LightMode.svg deleted file mode 100644 index da552de..0000000 --- a/fern/versions/v1.8/images/a7b65c5-LightMode.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/fern/versions/v1.8/images/acf7ea5-Overview.png b/fern/versions/v1.8/images/acf7ea5-Overview.png deleted file mode 100644 index daa0605..0000000 Binary files a/fern/versions/v1.8/images/acf7ea5-Overview.png and /dev/null differ diff --git a/fern/versions/v1.8/images/f0b81b5-FLOW-OF-FUNDS-APIS.png b/fern/versions/v1.8/images/f0b81b5-FLOW-OF-FUNDS-APIS.png deleted file mode 100644 index 18a2172..0000000 Binary files a/fern/versions/v1.8/images/f0b81b5-FLOW-OF-FUNDS-APIS.png and /dev/null differ diff --git a/fern/versions/v1.8/pages/api-backend/authentication-1.mdx b/fern/versions/v1.8/pages/api-backend/authentication-1.mdx deleted file mode 100644 index 513de56..0000000 --- a/fern/versions/v1.8/pages/api-backend/authentication-1.mdx +++ /dev/null @@ -1,173 +0,0 @@ ---- -title: "Authentication" -slug: "authentication-1" -subtitle: "" -hidden: false -createdAt: "Wed Jun 01 2022 23:44:11 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Tue Dec 12 2023 22:09:32 GMT+0000 (Coordinated Universal Time)" ---- -## API access - -In order to access the Chariot API, you will need to authenticate requests using the OAuth 2.0 [Client Credentials](https://auth0.com/docs/get-started/authentication-and-authorization-flow/client-credentials-flow) flow. - -- **OAuth 2.0 Access Token**: This is a JWT that should be provided as a Bearer token in the Authorization header for all API endpoints. This Access Token is temporary and once it expires you can request a new one. We recommend you save these tokens somewhere safe and re-use them until they expire so you can avoid having to re-fetch which can add latency to your requests. - -To obtain the necessary `client_id` and `client_secret` please email [support@givechariot.com](mailto:support@givechariot.com). - -### Getting an OAuth2.0 Access Token for your API - -You can execute a client credentials exchange to get an access token for Chariot. Here are a few examples in a variety of languages. Replace any `CLIENT_ID` and `CLIENT_SECRET` with the ones privately shared with you. Note that in this example we are retrieving an access token for the Chariot Sandbox environment. If you wanted to retrieve an access token for the Chariot Production environment, you would use the following URL `https://login.givechariot.com/oauth/token` with Production environment specific OAuth Client Credentials. - - -```curl cURL -curl --request POST \ - --url https://chariot-sandbox.us.auth0.com/oauth/token \ - --header 'content-type: application/json' \ - --data '{"client_id":"CLIENT_ID","client_secret":"CLIENT_SECRET","audience":"https://api.givechariot.com","grant_type":"client_credentials"}' -``` -```csharp C# -var client = new RestClient("https://chariot-sandbox.us.auth0.com/oauth/token"); -var request = new RestRequest(Method.POST); -request.AddHeader("content-type", "application/json"); -request.AddParameter("application/json", "{\"client_id\":\"CLIENT_ID\",\"client_secret\":\"CLIENT_SECRET\",\"audience\":\"https://api.givechariot.com\",\"grant_type\":\"client_credentials\"}", ParameterType.RequestBody); -IRestResponse response = client.Execute(request); -``` -```go Go -package main - -import ( - "fmt" - "strings" - "net/http" - "io/ioutil" -) - -func main() { - - url := "https://chariot-sandbox.us.auth0.com/oauth/token" - - payload := strings.NewReader("{\"client_id\":\"CLIENT_ID\",\"client_secret\":\"CLIENT_SECRET\",\"audience\":\"https://api.givechariot.com\",\"grant_type\":\"client_credentials\"}") - - req, _ := http.NewRequest("POST", url, payload) - - req.Header.Add("content-type", "application/json") - - res, _ := http.DefaultClient.Do(req) - - defer res.Body.Close() - body, _ := ioutil.ReadAll(res.Body) - - fmt.Println(res) - fmt.Println(string(body)) -} -``` -```java Java -HttpResponse response = Unirest.post("https://chariot-sandbox.us.auth0.com/oauth/token") - .header("content-type", "application/json") - .body("{\"client_id\":\"CLIENT_ID\",\"client_secret\":\"CLIENT_SECRET\",\"audience\":\"https://api.givechariot.com\",\"grant_type\":\"client_credentials\"}") - .asString(); -``` -```javascript jQuery -var settings = { - "async": true, - "crossDomain": true, - "url": "https://chariot-sandbox.us.auth0.com/oauth/token", - "method": "POST", - "headers": { - "content-type": "application/json" - }, - "data": "{\"client_id\":\"CLIENT_ID\",\"client_secret\":\"CLIENT_SECRET\",\"audience\":\"https://api.givechariot.com\",\"grant_type\":\"client_credentials\"}" -} - -$.ajax(settings).done(function (response) { - console.log(response); -}); -``` -```javascript NodeJS -var request = require("request"); - -var options = { method: 'POST', - url: 'https://chariot-sandbox.us.auth0.com/oauth/token', - headers: { 'content-type': 'application/json' }, - body: '{"client_id":"CLIENT_ID","client_secret":"CLIENT_SECRET","audience":"https://api.givechariot.com","grant_type":"client_credentials"}' }; - -request(options, function (error, response, body) { - if (error) throw new Error(error); - - console.log(body); -}); -``` -```php PHP -$curl = curl_init(); - -curl_setopt_array($curl, array( - CURLOPT_URL => "https://chariot-sandbox.us.auth0.com/oauth/token", - CURLOPT_RETURNTRANSFER => true, - CURLOPT_ENCODING => "", - CURLOPT_MAXREDIRS => 10, - CURLOPT_TIMEOUT => 30, - CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, - CURLOPT_CUSTOMREQUEST => "POST", - CURLOPT_POSTFIELDS => "{\"client_id\":\"CLIENT_ID\",\"client_secret\":\"CLIENT_SECRET\",\"audience\":\"https://api.givechariot.com\",\"grant_type\":\"client_credentials\"}", - CURLOPT_HTTPHEADER => array( - "content-type: application/json" - ), -)); - -$response = curl_exec($curl); -$err = curl_error($curl); - -curl_close($curl); - -if ($err) { - echo "cURL Error #:" . $err; -} else { - echo $response; -} -``` -```python Python -import http.client - -conn = http.client.HTTPSConnection("chariot-sandbox.us.auth0.com") - -payload = "{\"client_id\":\"CLIENT_ID\",\"client_secret\":\"CLIENT_SECRET\",\"audience\":\"https://api.givechariot.com\",\"grant_type\":\"client_credentials\"}" - -headers = { 'content-type': "application/json" } - -conn.request("POST", "/oauth/token", payload, headers) - -res = conn.getresponse() -data = res.read() - -print(data.decode("utf-8")) -``` -```ruby Ruby -require 'uri' -require 'net/http' - -url = URI("https://chariot-sandbox.us.auth0.com/oauth/token") - -http = Net::HTTP.new(url.host, url.port) -http.use_ssl = true -http.verify_mode = OpenSSL::SSL::VERIFY_NONE - -request = Net::HTTP::Post.new(url) -request["content-type"] = 'application/json' -request.body = "{\"client_id\":\"CLIENT_ID\",\"client_secret\":\"CLIENT_SECRET\",\"audience\":\"https://api.givechariot.com\",\"grant_type\":\"client_credentials\"}" - -response = http.request(request) -puts response.read_body -``` - - -**Response**: - -```json JSON -{ - "access_token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IlBfNkVWSWt0S2p5ZkhNNWdET3RMaSJ9.eyJpc3MiOiJodHRwczovL2NoYXJpb3QtZGV2LnVzLmF1dGgwLmNvbS8iLCJzdWIiOiJXSXpEaWVPaWY4a3Z0T2gxZUlxcGRTaDRUOWtYeFR0MUBjbGllbnRzIiwiYXVkIjoiaHR0cHM6Ly9hcGkuZ2l2ZWNoYXJpb3QuY29tIiwiaWF0IjoxNjc4MzI2MTUwLCJleHAiOjE2Nzg0MTI1NTAsImF6cCI6IldJekRpZU9pZjhrdnRPaDFlSXFwZFNoNFQ5a1h4VHQxIiwic2NvcGUiOiJyZWFkOnVzZXJzIHJlYWQ6dXNlciB1cGRhdGU6dXNlcnMgdXBkYXRlOnVzZXIgZGVsZXRlOnVzZXJzIGRlbGV0ZTp1c2VyIHJlYWQ6bm9ucHJvZml0cyByZWFkOm5vbnByb2ZpdCB1cGRhdGU6bm9ucHJvZml0cyB1cGRhdGU6bm9ucHJvZml0IGRlbGV0ZTpub25wcm9maXRzIGRlbGV0ZTpub25wcm9maXQgbGlzdDpncmFudHMgcmVhZDpncmFudHMgdXBkYXRlOmdyYW50cyBjcmVhdGU6Y29ubmVjdCByZWFkOmNvbm5lY3RzIHJlYWQ6Y29ubmVjdCB1cGRhdGU6Y29ubmVjdHMgdXBkYXRlOmNvbm5lY3QgZGVsZXRlOmNvbm5lY3RzIGRlbGV0ZTpjb25uZWN0IGV4Y2hhbmdlOnRva2VuIGNyZWF0ZTpncmFudHMgY3JlYXRlOnNhbmRib3ggcmVhZDpzYW5kYm94IGNyZWF0ZTpjb25uZWN0cyBsaXN0OmNvbm5lY3RzIGNyZWF0ZTpub25wcm9maXRzIiwiZ3R5IjoiY2xpZW50LWNyZWRlbnRpYWxzIiwicGVybWlzc2lvbnMiOlsicmVhZDp1c2VycyIsInJlYWQ6dXNlciIsInVwZGF0ZTp1c2VycyIsInVwZGF0ZTp1c2VyIiwiZGVsZXRlOnVzZXJzIiwiZGVsZXRlOnVzZXIiLCJyZWFkOm5vbnByb2ZpdHMiLCJyZWFkOm5vbnByb2ZpdCIsInVwZGF0ZTpub25wcm9maXRzIiwidXBkYXRlOm5vbnByb2ZpdCIsImRlbGV0ZTpub25wcm9maXRzIiwiZGVsZXRlOm5vbnByb2ZpdCIsImxpc3Q6Z3JhbnRzIiwicmVhZDpncmFudHMiLCJ1cGRhdGU6Z3JhbnRzIiwiY3JlYXRlOmNvbm5lY3QiLCJyZWFkOmNvbm5lY3RzIiwicmVhZDpjb25uZWN0IiwidXBkYXRlOmNvbm5lY3RzIiwidXBkYXRlOmNvbm5lY3QiLCJkZWxldGU6Y29ubmVjdHMiLCJkZWxldGU6Y29ubmVjdCIsImV4Y2hhbmdlOnRva2VuIiwiY3JlYXRlOmdyYW50cyIsImNyZWF0ZTpzYW5kYm94IiwicmVhZDpzYW5kYm94IiwiY3JlYXRlOmNvbm5lY3RzIiwibGlzdDpjb25uZWN0cyIsImNyZWF0ZTpub25wcm9maXRzIl19.nvRxt8u6Pynevl4H2zoskkZ4xxTwwAhauuE0Tko42vcZ8bSMAOHSQlV3Wvolqy9YIcYgQa9vWJ4BjaD62bBS7dmZJT9KmzV4dOaZV91hFfWY-rcgYQQIWE2RGUv6ptmjGjE2n15-eiPs7fWtPBD4rV7Y5hAkfkDkubtLtxvBhTP8SZZps0lQUoMQf0eKH1jLqdeXAy52Gi5ui25uc1iVB-rUdjLyK6GMO5hfeNMmuSs0rprXhTR9J0jreEL0I2-8lnyIbSSdHhj-tyaUbeVXhUt7ApatcMARAgqqp-anBUi00vux4ePl9O2xN8Lxo0vA5na7C53lken0PyRVCbXAyw", - "scope": "create:nonprofits read:nonprofits create:connects read:connects create:grants read:grants", - "expires_in": 86400, - "token_type": "Bearer" -} -``` - diff --git a/fern/versions/v1.8/pages/api-backend/errors-1.mdx b/fern/versions/v1.8/pages/api-backend/errors-1.mdx deleted file mode 100644 index d25eed1..0000000 --- a/fern/versions/v1.8/pages/api-backend/errors-1.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: "Error Codes" -slug: "errors-1" -subtitle: "" -hidden: false -createdAt: "Wed Jun 01 2022 23:46:21 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Wed Dec 20 2023 02:25:03 GMT+0000 (Coordinated Universal Time)" ---- -The Chariot API uses the standard HTTP status response codes - -| Code | Description | -| :--- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| 400 | Bad Request: The request could not be understood by the server due to malformed syntax. | -| 401 | Unauthorized: The request requires user authentication. The **Authorization** header may be missing or invalid. | -| 403 | Forbidden: The server understood the request but is refusing to fulfill it. The API user does not have correct permissions or the **x-chariot-api-key** header may be missing or invalid. | -| 404 | Not Found: The resource requested does not exist or was not found. | -| 405 | Method Not Allowed: The method/verb specified in the request is not allowed for the resource. | -| 409 | Conflict: The request conflicts with the current state of the target resource. | -| 410 | Gone: Access to the target resource is no longer available as the resource may have expired. | -| 422 | Unprocessable Content: The server cannot process the request due to validation issues | -| 500 | Internal Server Error: The request was valid, but something failed on the server. | -| 502 | Bad Gateway: The server received an invalid response from an upstream server. | -| 503 | Service Unavailable: The server is not ready to handle the request. | - -All error responses come with the following standard shape. - -```json JSON -{ - "timestamp": "2020-07-10 15:00:00.000", - "code": 400, - "error" : "Bad Request", - "message": "a descriptive, yet terse snippet explaining what went wrong" -} -``` - diff --git a/fern/versions/v1.8/pages/api-backend/grant-statuses.mdx b/fern/versions/v1.8/pages/api-backend/grant-statuses.mdx deleted file mode 100644 index 1416ce1..0000000 --- a/fern/versions/v1.8/pages/api-backend/grant-statuses.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "Grant Statuses" -slug: "grant-statuses" -subtitle: "Overview of Chariot Grant Statuses" -hidden: false -createdAt: "Tue Dec 12 2023 21:57:00 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Thu Mar 28 2024 22:17:59 GMT+0000 (Coordinated Universal Time)" ---- -The following describes the available set of statuses for grants that are initiated through Chariot. There is no guarantee that every grant initiated through Chariot will reach a final, completed state as a confirmation may be required from the receiving nonprofit. - -# Grants - -| Status | Description | What's next | -| :---------- | :--------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Initiated` | The payment has been successfully received by the DAF provider. | The status will move to `Completed` state when the nonprofit receives the payment from the DAF provider. It will move to `Canceled` if the payment is never received by the nonprofit. | -| `Canceled` | The grant was canceled by the donor or the DAF provider did not approve the grant. | The nonprofit should let Chariot know that the payment did not arrive. No processing fees will be taken/charged. | -| `Completed` | The payment has been completed and the funds are in the nonprofit's bank. | | - diff --git a/fern/versions/v1.8/pages/api-backend/overview.mdx b/fern/versions/v1.8/pages/api-backend/overview.mdx deleted file mode 100644 index e8f20a2..0000000 --- a/fern/versions/v1.8/pages/api-backend/overview.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "Overview" -slug: "overview" -subtitle: "A comprehensive reference for integrating with Chariot API endpoints" -hidden: false -createdAt: "Wed Jun 01 2022 23:43:34 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Tue Dec 12 2023 22:09:31 GMT+0000 (Coordinated Universal Time)" ---- -The Chariot API is organized around REST. Our API has predictable resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs. - - - If you feel like something is missing from our API docs, feel free to create an **Issue** on our [OpenAPI GitHub repo](https://github.com/chariot-giving/chariot-openapi). - - -## API protocols and headers - -The Chariot API uses standard HTTP response codes to indicate status and errors. All responses come in standard JSON. The Chariot API is served over HTTPS TLS v1.2+ to ensure data privacy; HTTP and HTTPS with TLS versions below 1.2 are not supported. All requests with a payload must include a Content-Type of application/JSON and the body must be valid JSON. - -Every Chariot API response includes a request_id as the `X-Request-Id` header. The request_id is included whether the API request succeeded or failed. For faster support, include the request_id when contacting support regarding a specific API call. - -## API host - -```javascript Server.js -https://sandboxapi.givechariot.com (Sandbox) -https://api.givechariot.com (Production) -``` - -Chariot has two environments: Sandbox and Production. The Sandbox environment supports only test data. All activity in the Production environment is real. When you’re getting ready to launch into production, please let us know by emailing [support@givechariot.com](mailto:support@givechariot.com) to get your production credentials. - diff --git a/fern/versions/v1.8/pages/api-backend/postman.mdx b/fern/versions/v1.8/pages/api-backend/postman.mdx deleted file mode 100644 index 2d55a93..0000000 --- a/fern/versions/v1.8/pages/api-backend/postman.mdx +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: "Postman" -slug: "postman" -subtitle: "" -hidden: false -createdAt: "Thu Feb 23 2023 03:07:32 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Tue Dec 12 2023 22:09:31 GMT+0000 (Coordinated Universal Time)" ---- -# Chariot API Postman - -## Fork the Collection - -If you normally use Postman for API development, you can fork the collection from [Chariot's Public Workspace](https://www.postman.com/givechariot/workspace/chariot-public-workspace/overview) to test out and develop against the Chariot APIs within Postman. - -[![Run in Postman](https://run.pstmn.io/button.svg)](https://app.getpostman.com/run-collection/23306205-95018796-5a2c-4332-99a0-472c1b32bae1?action=collection%2Ffork&collection-url=entityId%3D23306205-95018796-5a2c-4332-99a0-472c1b32bae1%26entityType%3Dcollection%26workspaceId%3Dc7217a87-0e57-45c0-8ead-53c23b4ec878#?env%5BSandbox%5D=W3sia2V5IjoiYmFzZVVybCIsInZhbHVlIjoiaHR0cHM6Ly9zYW5kYm94YXBpLmdpdmVjaGFyaW90LmNvbSIsImVuYWJsZWQiOnRydWUsInR5cGUiOiJkZWZhdWx0Iiwic2Vzc2lvblZhbHVlIjoiaHR0cHM6Ly9zYW5kYm94YXBpLmdpdmVjaGFyaW90LmNvbSIsInNlc3Npb25JbmRleCI6MH0seyJrZXkiOiJvYXV0aFRva2VuVXJsIiwidmFsdWUiOiJodHRwczovL2NoYXJpb3Qtc2FuZGJveC51cy5hdXRoMC5jb20vb2F1dGgvdG9rZW4iLCJlbmFibGVkIjp0cnVlLCJ0eXBlIjoiZGVmYXVsdCIsInNlc3Npb25WYWx1ZSI6Imh0dHBzOi8vY2hhcmlvdC1zYW5kYm94LnVzLmF1dGgwLmNvbS9vYXV0aC90b2tlbiIsInNlc3Npb25JbmRleCI6MX0seyJrZXkiOiJvYXV0aENsaWVudElkIiwidmFsdWUiOiIiLCJlbmFibGVkIjpmYWxzZSwidHlwZSI6ImRlZmF1bHQiLCJzZXNzaW9uVmFsdWUiOiIiLCJzZXNzaW9uSW5kZXgiOjJ9LHsia2V5Ijoib2F1dGhDbGllbnRTZWNyZXQiLCJ2YWx1ZSI6IiIsImVuYWJsZWQiOmZhbHNlLCJ0eXBlIjoic2VjcmV0Iiwic2Vzc2lvblZhbHVlIjoiIiwic2Vzc2lvbkluZGV4IjozfV0=) - -## Setup Environments - -- Sandbox - This is the testing environment that you should use in a pre-production environment while developing and testing the Chariot integration. -- Production - This is the production environment that you should use for real data and donations. - -## Setup Authorization - -To run requests you'll need to configure OAuth2 Authorization using your OAuth Client Credentials. - -You can setup OAuth authorization at the collection level and reuse the same OAuth token for all requests within the collection. The best practice is to leverage the Postman Environments provided to save and re-use environment-related variables such as the following to make it simple to setup OAuth: - -- `oauthTokenUrl` - the OAuth Token URL endpoint -- `oauthClientId` - the OAuth Client ID -- `oauthClientSecret` - the OAuth Client Secret - diff --git a/fern/versions/v1.8/pages/chariot-api/connects-1.mdx b/fern/versions/v1.8/pages/chariot-api/connects-1.mdx deleted file mode 100644 index 3d0ba27..0000000 --- a/fern/versions/v1.8/pages/chariot-api/connects-1.mdx +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: "Connects" -slug: "connects-1" -subtitle: "" -hidden: false -createdAt: "Fri Jan 26 2024 19:37:55 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Fri Jan 26 2024 19:37:55 GMT+0000 (Coordinated Universal Time)" ---- - diff --git a/fern/versions/v1.8/pages/chariot-api/connects-1/create-connect.mdx b/fern/versions/v1.8/pages/chariot-api/connects-1/create-connect.mdx deleted file mode 100644 index 6b49cff..0000000 --- a/fern/versions/v1.8/pages/chariot-api/connects-1/create-connect.mdx +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: "Create Connect" -slug: "create-connect" -subtitle: "Get or create a Connect object. Only one Connect object can be created per Nonprofit for a given Fundraising Application. If one already exists, this will return a 200 status with the existing object. The returned Connect can be used to integrate the client-side Chariot Connect component using the id property (CID) and also query for data generated from the Chariot Connect instance from the Chariot API using the apiKey property." -hidden: false -createdAt: "Fri Dec 16 2022 20:26:29 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Fri Jan 26 2024 19:37:55 GMT+0000 (Coordinated Universal Time)" ---- - diff --git a/fern/versions/v1.8/pages/chariot-api/connects-1/get-connect.mdx b/fern/versions/v1.8/pages/chariot-api/connects-1/get-connect.mdx deleted file mode 100644 index de69291..0000000 --- a/fern/versions/v1.8/pages/chariot-api/connects-1/get-connect.mdx +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: "Get Connect" -slug: "get-connect" -subtitle: "Get a Connect object with the unique identifier (CID)" -hidden: false -createdAt: "Mon Dec 19 2022 20:57:07 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Fri Jan 26 2024 19:37:55 GMT+0000 (Coordinated Universal Time)" ---- - diff --git a/fern/versions/v1.8/pages/chariot-api/dafs-1.mdx b/fern/versions/v1.8/pages/chariot-api/dafs-1.mdx deleted file mode 100644 index 6f53da0..0000000 --- a/fern/versions/v1.8/pages/chariot-api/dafs-1.mdx +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: "DAFs" -slug: "dafs-1" -subtitle: "" -hidden: false -createdAt: "Fri Jan 26 2024 19:37:55 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Fri Jan 26 2024 19:37:55 GMT+0000 (Coordinated Universal Time)" ---- - diff --git a/fern/versions/v1.8/pages/chariot-api/dafs-1/get-daf.mdx b/fern/versions/v1.8/pages/chariot-api/dafs-1/get-daf.mdx deleted file mode 100644 index f7a9ca8..0000000 --- a/fern/versions/v1.8/pages/chariot-api/dafs-1/get-daf.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "Get DAF object" -slug: "get-daf" -subtitle: "Get a DAF object by id.\nIf the DAF does not exist, returns a 404 status.\nIf the provided ID is not a v4 UUID according to RFC 4122, returns a 400 status." -hidden: false -createdAt: "Wed Feb 22 2023 15:44:30 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Fri Jan 26 2024 19:37:55 GMT+0000 (Coordinated Universal Time)" ---- -If the provided ID is not a v4 UUID according to RFC 4122, returns a 400 status. - -If the DAF does not exist, returns a 404 status. - diff --git a/fern/versions/v1.8/pages/chariot-api/dafs-1/list-dafs.mdx b/fern/versions/v1.8/pages/chariot-api/dafs-1/list-dafs.mdx deleted file mode 100644 index fc5e97c..0000000 --- a/fern/versions/v1.8/pages/chariot-api/dafs-1/list-dafs.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "List DAFs" -slug: "list-dafs" -subtitle: "List all DAF objects. This API allows for paginating over many results." -hidden: false -createdAt: "Wed Feb 22 2023 15:44:30 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Fri Jan 26 2024 19:37:55 GMT+0000 (Coordinated Universal Time)" ---- -Returns a list of the Donor Advised Fund providers that are supported through Chariot. - -This API allows for paginating over many results. - diff --git a/fern/versions/v1.8/pages/chariot-api/event-subscriptions.mdx b/fern/versions/v1.8/pages/chariot-api/event-subscriptions.mdx deleted file mode 100644 index 382655f..0000000 --- a/fern/versions/v1.8/pages/chariot-api/event-subscriptions.mdx +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: "Event Subscriptions" -slug: "event-subscriptions" -subtitle: "" -hidden: false -createdAt: "Fri Jan 26 2024 19:37:55 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Wed Apr 17 2024 17:28:37 GMT+0000 (Coordinated Universal Time)" ---- - diff --git a/fern/versions/v1.8/pages/chariot-api/event-subscriptions/createeventsubscription.mdx b/fern/versions/v1.8/pages/chariot-api/event-subscriptions/createeventsubscription.mdx deleted file mode 100644 index 1c2704e..0000000 --- a/fern/versions/v1.8/pages/chariot-api/event-subscriptions/createeventsubscription.mdx +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: "Create an Event Subscription" -slug: "createeventsubscription" -subtitle: "Create an event subscription corresponding to your Chariot account." -hidden: false -createdAt: "Tue Jan 23 2024 19:47:17 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Wed Apr 17 2024 17:28:37 GMT+0000 (Coordinated Universal Time)" ---- - diff --git a/fern/versions/v1.8/pages/chariot-api/event-subscriptions/geteventsubscription.mdx b/fern/versions/v1.8/pages/chariot-api/event-subscriptions/geteventsubscription.mdx deleted file mode 100644 index 55beeed..0000000 --- a/fern/versions/v1.8/pages/chariot-api/event-subscriptions/geteventsubscription.mdx +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: "Retrieve an Event Subscription" -slug: "geteventsubscription" -subtitle: "Retrieve an event subscription corresponding to your Chariot account." -hidden: false -createdAt: "Tue Jan 23 2024 19:47:17 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Wed Apr 17 2024 17:28:37 GMT+0000 (Coordinated Universal Time)" ---- - diff --git a/fern/versions/v1.8/pages/chariot-api/event-subscriptions/listeventsubscriptions.mdx b/fern/versions/v1.8/pages/chariot-api/event-subscriptions/listeventsubscriptions.mdx deleted file mode 100644 index 2913c4e..0000000 --- a/fern/versions/v1.8/pages/chariot-api/event-subscriptions/listeventsubscriptions.mdx +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: "List Event Subscriptions" -slug: "listeventsubscriptions" -subtitle: "List all event subscriptions corresponding to your Chariot account." -hidden: false -createdAt: "Tue Jan 23 2024 19:47:17 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Wed Apr 17 2024 17:28:37 GMT+0000 (Coordinated Universal Time)" ---- - diff --git a/fern/versions/v1.8/pages/chariot-api/event-subscriptions/updateeventsubscription.mdx b/fern/versions/v1.8/pages/chariot-api/event-subscriptions/updateeventsubscription.mdx deleted file mode 100644 index 7e0d2e9..0000000 --- a/fern/versions/v1.8/pages/chariot-api/event-subscriptions/updateeventsubscription.mdx +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: "Update an Event Subscription" -slug: "updateeventsubscription" -subtitle: "Update an event subscription corresponding to your Chariot account." -hidden: false -createdAt: "Tue Jan 23 2024 19:47:17 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Wed Apr 17 2024 17:28:37 GMT+0000 (Coordinated Universal Time)" ---- - diff --git a/fern/versions/v1.8/pages/chariot-api/events-1.mdx b/fern/versions/v1.8/pages/chariot-api/events-1.mdx deleted file mode 100644 index efd2264..0000000 --- a/fern/versions/v1.8/pages/chariot-api/events-1.mdx +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: "Events" -slug: "events-1" -subtitle: "" -hidden: false -createdAt: "Fri Jan 26 2024 19:37:55 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Wed Apr 17 2024 17:28:31 GMT+0000 (Coordinated Universal Time)" ---- - diff --git a/fern/versions/v1.8/pages/chariot-api/events-1/getevent.mdx b/fern/versions/v1.8/pages/chariot-api/events-1/getevent.mdx deleted file mode 100644 index 83e08fc..0000000 --- a/fern/versions/v1.8/pages/chariot-api/events-1/getevent.mdx +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: "Retrieve an Event" -slug: "getevent" -subtitle: "Retrieve an event corresponding to your Chariot account." -hidden: false -createdAt: "Tue Jan 23 2024 19:47:17 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Wed Apr 17 2024 17:28:31 GMT+0000 (Coordinated Universal Time)" ---- - diff --git a/fern/versions/v1.8/pages/chariot-api/events-1/listevents.mdx b/fern/versions/v1.8/pages/chariot-api/events-1/listevents.mdx deleted file mode 100644 index 04a52f1..0000000 --- a/fern/versions/v1.8/pages/chariot-api/events-1/listevents.mdx +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: "List Events" -slug: "listevents" -subtitle: "List all events corresponding to your Chariot account." -hidden: false -createdAt: "Tue Jan 23 2024 19:47:17 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Wed Apr 17 2024 17:28:31 GMT+0000 (Coordinated Universal Time)" ---- - diff --git a/fern/versions/v1.8/pages/chariot-api/grants-1.mdx b/fern/versions/v1.8/pages/chariot-api/grants-1.mdx deleted file mode 100644 index 1fa7734..0000000 --- a/fern/versions/v1.8/pages/chariot-api/grants-1.mdx +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: "Grants" -slug: "grants-1" -subtitle: "" -hidden: false -createdAt: "Fri Jan 26 2024 19:37:55 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Fri Jan 26 2024 19:37:55 GMT+0000 (Coordinated Universal Time)" ---- - diff --git a/fern/versions/v1.8/pages/chariot-api/grants-1/get-grant.mdx b/fern/versions/v1.8/pages/chariot-api/grants-1/get-grant.mdx deleted file mode 100644 index d2b7188..0000000 --- a/fern/versions/v1.8/pages/chariot-api/grants-1/get-grant.mdx +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: "Get Grant" -slug: "get-grant" -subtitle: "Get a grant object generated by Chariot Connect.\nIf the grant does not exist, returns a 404 status.\nIf the provided ID is not a v4 UUID according to RFC 4122, returns a 400 status." -hidden: false -createdAt: "Sun Oct 16 2022 15:25:23 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Fri Jan 26 2024 19:37:55 GMT+0000 (Coordinated Universal Time)" ---- - diff --git a/fern/versions/v1.8/pages/chariot-api/grants-1/get-unintegrated-grant.mdx b/fern/versions/v1.8/pages/chariot-api/grants-1/get-unintegrated-grant.mdx deleted file mode 100644 index 68c2a7f..0000000 --- a/fern/versions/v1.8/pages/chariot-api/grants-1/get-unintegrated-grant.mdx +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: "Get Unintegrated Grant" -slug: "get-unintegrated-grant" -subtitle: "Get an unintegrated grant object generated by Chariot Connect.\nIf the grant does not exist, returns a 404 status.\nIf the provided ID is not a v4 UUID according to RFC 4122, returns a 400 status." -hidden: false -createdAt: "Tue Jan 30 2024 22:38:20 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Tue Jan 30 2024 22:38:20 GMT+0000 (Coordinated Universal Time)" ---- - diff --git a/fern/versions/v1.8/pages/chariot-api/grants-1/list-grants.mdx b/fern/versions/v1.8/pages/chariot-api/grants-1/list-grants.mdx deleted file mode 100644 index fb32efe..0000000 --- a/fern/versions/v1.8/pages/chariot-api/grants-1/list-grants.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "List Grants" -slug: "list-grants" -subtitle: "List all grants for the provided API Key. This API allows for paginating over many results." -hidden: false -createdAt: "Fri Nov 11 2022 21:12:48 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Fri Jan 26 2024 19:37:55 GMT+0000 (Coordinated Universal Time)" ---- -Returns a list of Grants that were created from an instance of [Connect](/api-reference/connects/get). The `apiKey` from the Connect object should be passed in the `x-chariot-api-key` header for this request. - -This API allows for paginating over many results. - diff --git a/fern/versions/v1.8/pages/chariot-api/grants-1/list-unintegrated-grants.mdx b/fern/versions/v1.8/pages/chariot-api/grants-1/list-unintegrated-grants.mdx deleted file mode 100644 index 1f0a374..0000000 --- a/fern/versions/v1.8/pages/chariot-api/grants-1/list-unintegrated-grants.mdx +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: "List Unintegrated Grants" -slug: "list-unintegrated-grants" -subtitle: "List all unintegrated grants for the provided API Key. This API allows for paginating over many results." -hidden: false -createdAt: "Tue Jan 30 2024 22:38:20 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Tue Jan 30 2024 22:38:20 GMT+0000 (Coordinated Universal Time)" ---- - diff --git a/fern/versions/v1.8/pages/chariot-api/grants-1/update-grant.mdx b/fern/versions/v1.8/pages/chariot-api/grants-1/update-grant.mdx deleted file mode 100644 index fae0626..0000000 --- a/fern/versions/v1.8/pages/chariot-api/grants-1/update-grant.mdx +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: "Update Grant" -slug: "update-grant" -subtitle: "Update a grant object generated by Chariot Connect.\nThis is useful to update the status or acknowledgement of the grant.\nIf the grant does not exist, returns a 404 status.\nIf the provided ID is not a v4 UUID according to RFC 4122, returns a 400 status." -hidden: false -createdAt: "Tue Jan 30 2024 22:38:20 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Tue Jan 30 2024 22:38:20 GMT+0000 (Coordinated Universal Time)" ---- - diff --git a/fern/versions/v1.8/pages/chariot-api/grants-1/update-unintegrated-grant.mdx b/fern/versions/v1.8/pages/chariot-api/grants-1/update-unintegrated-grant.mdx deleted file mode 100644 index 48cc3a5..0000000 --- a/fern/versions/v1.8/pages/chariot-api/grants-1/update-unintegrated-grant.mdx +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: "Update Unintegrated Grant" -slug: "update-unintegrated-grant" -subtitle: "Update an unintegrated grant object generated by Chariot Connect.\nThis is useful to update the status or acknowledgement of the unintegrated grant.\nIf the unintegrated grant does not exist, returns a 404 status.\nIf the provided ID is not a v4 UUID according to RFC 4122, returns a 400 status." -hidden: false -createdAt: "Tue Jan 30 2024 22:38:20 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Tue Jan 30 2024 22:38:20 GMT+0000 (Coordinated Universal Time)" ---- - diff --git a/fern/versions/v1.8/pages/chariot-api/nonprofits-1.mdx b/fern/versions/v1.8/pages/chariot-api/nonprofits-1.mdx deleted file mode 100644 index 83fe520..0000000 --- a/fern/versions/v1.8/pages/chariot-api/nonprofits-1.mdx +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: "Nonprofits" -slug: "nonprofits-1" -subtitle: "" -hidden: false -createdAt: "Fri Jan 26 2024 19:37:55 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Fri Jan 26 2024 19:37:55 GMT+0000 (Coordinated Universal Time)" ---- - diff --git a/fern/versions/v1.8/pages/chariot-api/nonprofits-1/create-nonprofit.mdx b/fern/versions/v1.8/pages/chariot-api/nonprofits-1/create-nonprofit.mdx deleted file mode 100644 index e2f9609..0000000 --- a/fern/versions/v1.8/pages/chariot-api/nonprofits-1/create-nonprofit.mdx +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: "Create nonprofit" -slug: "create-nonprofit" -subtitle: "Create a nonprofit organization account.\nThis is useful for integration partners to use after a nonprofit consents to use the Chariot payment option on their donation forms.\nIf a nonprofit does not already exist for the EIN, this will return a 201 Created status.\nIf a nonprofit already exists for the given EIN on the system, this will return a 200 Created status.\nIf the nonprofit does not pass our compliance checks, a 422 Unprocessable Content is returned with a reason." -hidden: false -createdAt: "Fri Dec 16 2022 20:26:29 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Fri Jan 26 2024 19:37:55 GMT+0000 (Coordinated Universal Time)" ---- - diff --git a/fern/versions/v1.8/pages/chariot-api/nonprofits-1/get-nonprofit-by-ein.mdx b/fern/versions/v1.8/pages/chariot-api/nonprofits-1/get-nonprofit-by-ein.mdx deleted file mode 100644 index b7d2e4a..0000000 --- a/fern/versions/v1.8/pages/chariot-api/nonprofits-1/get-nonprofit-by-ein.mdx +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: "Get nonprofit by EIN" -slug: "get-nonprofit-by-ein" -subtitle: "Get a nonprofit organization by EIN.\nIf the nonprofit does not exist, this returns 404 Not Found status.\nIf the nonprofit does not pass our compliance checks, a 422 Unprocessable Content is returned with a reason.\nIn the case that the nonprofit does not exist, you can create one by calling the POST /v1/nonprofits API endpoint.\nThe EIN should be exactly 9 digits and should not contain any special characters such as dashes." -hidden: true -createdAt: "Fri Dec 16 2022 20:26:29 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Fri Mar 29 2024 17:20:54 GMT+0000 (Coordinated Universal Time)" ---- - diff --git a/fern/versions/v1.8/pages/chariot-api/nonprofits-1/get-nonprofit-by-id.mdx b/fern/versions/v1.8/pages/chariot-api/nonprofits-1/get-nonprofit-by-id.mdx deleted file mode 100644 index 239a34e..0000000 --- a/fern/versions/v1.8/pages/chariot-api/nonprofits-1/get-nonprofit-by-id.mdx +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: "Get nonprofit by ID" -slug: "get-nonprofit-by-id" -subtitle: "Get a nonprofit organization by ID.\nIf the nonprofit does not exist, this returns 404 Not Found status." -hidden: false -createdAt: "Mon Mar 25 2024 21:56:32 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Mon Mar 25 2024 21:56:32 GMT+0000 (Coordinated Universal Time)" ---- - diff --git a/fern/versions/v1.8/pages/chariot-connect/chariot-connect-overview.mdx b/fern/versions/v1.8/pages/chariot-connect/chariot-connect-overview.mdx deleted file mode 100644 index b0625d7..0000000 --- a/fern/versions/v1.8/pages/chariot-connect/chariot-connect-overview.mdx +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: "Overview" -slug: "chariot-connect-overview" -subtitle: "Use Chariot Connect to allow users to initiate grant requests from their Donor Advised Funds" -hidden: false -metadata: - image: [] - robots: "index" -createdAt: "Tue May 31 2022 18:36:21 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Thu Jun 02 2022 19:16:01 GMT+0000 (Coordinated Universal Time)" ---- -# Chariot Connect - -![](../../images/9339d40-Connect-no-words.png "Connect-no-words.png") -## Introduction - -Chariot Connect is the client-side component that your users will interact with in order to initiate grant recommendations from their Donor Advised Funds. - -Chariot Connect will handle credential validation, multi-factor authentication, and error handling for each Donor Advised Fund that we support. Connect works across all modern browsers and platforms. - -## Initialization - -Chariot Connect is initialized by passing a **connect_token** to Connect's configuration. This token is generated by calling the [/connect/token/retreive](/api-reference/connects/get_token) endpoint. Additionally, onSuccess and onExit callback functions can be set to handle successful and unsuccessful donation attempts. For more information, see [Integrating Connect](doc:connect-for-web). - -## Connect flow overview - -The diagram below shows a model of how Chariot Connect is initialized using a connect_token. It then shows how to retrieve the data the button generated by calling the Connect API. -
- -![](../../images/acf7ea5-Overview.png "Overview.png") diff --git a/fern/versions/v1.8/pages/chariot-connect/connect-for-web.mdx b/fern/versions/v1.8/pages/chariot-connect/connect-for-web.mdx deleted file mode 100644 index b3c02b2..0000000 --- a/fern/versions/v1.8/pages/chariot-connect/connect-for-web.mdx +++ /dev/null @@ -1,143 +0,0 @@ ---- -title: "Integrating Connect" -slug: "connect-for-web" -subtitle: "Reference for initializing Chariot Connect using Chariot JavaScript SDK" -hidden: false -metadata: - image: [] - robots: "index" -createdAt: "Tue May 31 2022 18:52:52 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Thu Jun 02 2022 19:03:29 GMT+0000 (Coordinated Universal Time)" ---- -Include the Chariot Connect initialize script on each page of your site. It must always be loaded directly from [https://cdn.givechariot.com](https://cdn.givechariot.com), rather than included in a bundle or hosted yourself - -```javascript index.html - -``` - -## Create - -Chariot.create accepts one argument, a configuration Object, and returns an Object with three functions, open, exit, and destroy. Calling open will display the Consent Pane view, calling exit will close Connect, and calling destroy will clean up the iframe. - -```javascript Create Example -const handler = Chariot.create({ - connect_token: 'GENERATED_CONNECT_TOKEN', - onSuccess: (metadata) => {}, - onExit: (err, metadata) => {} -}); -``` - -| Parameter | Description | Type | -| :---------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | :------- | -| **connect_token** | Specify a connect_token which allows Connect to know which nonprofit the funds are being sent to and add the nonprofit's customized wording to the Connect flow. This token does not expire but the nonprofit can revoke it. Receive this token by calling the [Get Connect Token](/api-reference/connects/get_token) endpoint. | string | -| **onSuccess** | A function that is called when a user successfully completes a grant request through Connect. The function should expect one argument, a metadata object. | callback | -| **onExit** | A function that is called when a user exits Connect without successfully initiating a grant request, or when an error occurs during Connect initialization. The function should expect two arguments, a nullable error object and a metadata object. | callback | - -## onSuccess - -The onSuccess callback is called when a user successfully initiates a grant request. It takes one argument: a metadata object. - -```javascript onSuccess example -const handler = Chariot.create({ - ..., - onSuccess: (metadata) => { - fetch('//yourserver.com/metadata', { - method: 'POST', - body: { - //Save whatever info you may want from the metadata - }, - }); - } -}); -``` - -```json Metadata schema -{ - institution:{ - name:"Fidelity Charitable", - institution_id:"ins_4" - }, - grant: { - id:"ygPnJweommTWNr9doD6ZfGR6GGVQy7fyREmWy", - amount:{ - amount:2000, - amountString:"$20" - }, - status : "RECEIVED", - organizationId:"064ccc97-fc4d-489a-8487-5b4731786d39", - contactInformationFields:{ - name: "John Smith", - email: "johnsmith@gmail.com", - phone: "000-000-0000" - }, - designation:"where_needed_most", - frequency:"once", - personalNote:"This is my first donation through CharityVest!" - }, - connect_session_id:"79e772be-547d-4c9c-8b76-4ac4ed4c441a" -} -``` - -| Parameter | Description | Type | -| :--------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :---------------- | -| **institution.name** | A readable format of the Donor Advised Fund institution that received this donation request | string | -| **institution.institution_id** | A unique identifier for the Donor Advised Fund institution | string | -| **grant.id** | A unique identifier for this grant | string | -| **grant.amount** | The amount requested to be donated | object | -| **grant.status** | The status of the grant. Learn more in [Webhooks](/api-reference/webhooks) | string (enum) | -| **grant.organizationId** | a unique identifier for the nonprofit organization receiving the donation | string | -| **grant.contactInformationFields** | contact information the donor has approved to share | object | -| **grant.designation** | the specific fund the donor wants to send the money to | string (optional) | -| **grant.frequency** | the frequency for the donation. The options for this field are set by the nonprofit | string | -| **grant.personalNote** | a free form note the donor included in the donation | string (optional) | -| **connect_session_id** | a unique identifier associated with a user's actions and events through the Connect flow. Include this identifier when opening a support ticket for faster turnaround. | string | - -## OnExit - -The onExit callback is called when a user exits Connect without successfully initiating a grant request, or when an error occurs during Connect initialization. It takes two arguments, a nullable error object and a metadata object. The metadata parameter is always present, though some values may be null. - -```javascript onExit example -const handler = Chariot.create({ - ..., - onExit: (error, metadata) => { - // Save data from the onExit handler - supportHandler.report({ - error: error, - institution: metadata.institution, - connect_session_id: metadata.connect_session_id, - chariot_request_id: metadata.request_id, - status: metadata.status, - }); - }, -}); -``` - -```javascript Errror schema -{ - error_type: 'ITEM_ERROR', - error_code: 'INVALID_CREDENTIALS', - error_message: 'the credentials were not correct', - display_message: 'The credentials were not correct.', -} -``` - -```json Metadata schema -{ - institution: { - name: 'Fidelity Charitable', - institution_id: 'ins_4' - }, - status: 'requires_credentials', - chariot_session_id: '36e201e0-2280-46f0-a6ee-6d417b450438', - request_id: '8C7jNbDScC24THu' -} -``` - -| Parameter | Description | Type | -| :---------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :----- | -| **institution.name** | The full institution name, such as "Fidelity Charitable" | string | -| **institution.id** | The Chariot Donor Advised Fund identifier | string | -| **status** | The point at which the user exited the Connect flow. One of the following values | string | -| **chariot_session_id** | A unique identifier associated with a user's actions and events through the Connect flow. Include this identifier when opening a support ticket for faster turnaround. | string | -| **request_id** | The request ID for the last request made by Connect. This can be shared with Chariot Support to expedite investigation. | string | - diff --git a/fern/versions/v1.8/pages/chariot-connect/error-handling.mdx b/fern/versions/v1.8/pages/chariot-connect/error-handling.mdx deleted file mode 100644 index 9d772c3..0000000 --- a/fern/versions/v1.8/pages/chariot-connect/error-handling.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: "Error Handling" -slug: "error-handling" -subtitle: "" -hidden: false -metadata: - image: [] - robots: "index" -createdAt: "Tue May 31 2022 19:09:56 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Thu Jun 02 2022 19:08:44 GMT+0000 (Coordinated Universal Time)" ---- -### Missing institution or "Connectivity not supported" error - -If your user has a Donor-Advised Fund that Chariot does not currently integrate with, then Connect will allow the user to select that DAF and give detailed instructions on how to complete their DAF donation. Connect will hyperlink the user to their DAF login portal and allow the donor to notify Chariot that the donation was placed. - -[Insert image showing modules] - -### Institution status in Connect - -Connect proactively lets users know if an institution's connection isn't performing well. Below are the three views a user will see depending on the status of the institution they select. - -When the status of an institution is DEGRADED, Connect will warn users that they may experience issues and allow them to continue. Once the status becomes DOWN, Connect will block users from attempting to log in and suggest the "Missing Institution" flow described above - -![](../../images/41e910d-Group_549.png "Group 549.png") diff --git a/fern/versions/v1.8/pages/connect-frontend/button-styles.mdx b/fern/versions/v1.8/pages/connect-frontend/button-styles.mdx deleted file mode 100644 index 49a0ffe..0000000 --- a/fern/versions/v1.8/pages/connect-frontend/button-styles.mdx +++ /dev/null @@ -1,92 +0,0 @@ ---- -title: "Button Styles" -slug: "button-styles" -subtitle: "Provided styles for the Chariot Connect button" -hidden: false -createdAt: "Mon Feb 20 2023 16:24:01 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Thu Feb 15 2024 17:21:29 GMT+0000 (Coordinated Universal Time)" ---- -# Using a default theme - -Choose your theme by adding the theme name as a parameter to the `chariot-connect` modal, as below. - - -```html HTML - -> - -``` -```javascript React - - ... -/> -``` - - -We provide the options below as default themes. If `theme` is not defined, `DefaultTheme` will be used. - -## `DefaultTheme` - - - - -## `LightModeTheme` - - - - -## `LightBlueTheme` - - - - -## `GradientTheme` - - - - -# Creating a custom theme - -To create a custom theme for the Chariot Connect button, create an object with the desired properties that you wish to change. Utilize [Tailwind CSS](https://tailwindcss.com/) styling in the definition of these properties. - - - Style customizations for Chariot Connect require that all available CSS be packaged within the `chariot-connect.umd.js` bundle. The problem is that for Chariot to allow any customizations, we would need to include the entire [tailwindcss](https://v1.tailwindcss.com/docs/controlling-file-size) package (~2.4Mb uncompressed) which would degrade performance and load times to an unacceptable level. While performance is a concern, we also realize the need for a consistent and seamless user experience and are also committed to providing configurations for size, padding, border radius, etc. on top of the pre-built themes that we offer. - - -```javascript JavaScript -// get the element from the DOM -const chariot = document.getElementById("chariot") - -// define your alterations using valid properties from the table below -const alterations = { - width: "w-12", - height: "h-8", -}; - -// register your new theme with a custom name -chariot.registerTheme("myTheme", alterations); -``` -```javascript React - -``` - -### Theme Properties - -| Parameter Name | Use | Allowed value | -| :----------------- | :--------------------------------------------------------------------------------------- | :---------------------------------------------------------------------------------------- | -| `width` | The width of the button | [width](https://tailwindcss.com/docs/width) up to `16` or `64px` | -| `height` | The height of the button | [height](https://tailwindcss.com/docs/height) at least `9` or `36px` up to `12` or `48px` | -| `showExtendedText` | Show an extended text (`Give with Donor Advised Fund`) version of the DAFpay button text | `true` or `false` (this value is `false` by default) | - diff --git a/fern/versions/v1.8/pages/connect-frontend/configurations.mdx b/fern/versions/v1.8/pages/connect-frontend/configurations.mdx deleted file mode 100644 index 97e4a63..0000000 --- a/fern/versions/v1.8/pages/connect-frontend/configurations.mdx +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: "Workflow Configurations" -slug: "configurations" -subtitle: "" -hidden: false -createdAt: "Mon Dec 18 2023 21:56:47 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Tue Mar 05 2024 21:53:28 GMT+0000 (Coordinated Universal Time)" ---- -Chariot allows for a couple of workflow configurations. To change any of the default configurations, please email [support@givechariot.com](mailto:support@givechariot.com) - -### Disable unintegrated grant submissions - - - - -If a user selects an unintegrated DAF, the workflow can be configured to prompt closing the modal and selecting another payment option (see image above). This option is typically chosen if users prefer to avoid redirection away from the page to complete the gift elsewhere. - -### Donate versus Continue - - - - -In the final pane of the workflow, the call-to-action button can be configured to show "Continue" instead of "Donate" (refer to the image above). Those preferring their users to input additional information after the Connect experience choose to alter the button to "Continue". - -### Autofill Donor Information - -The Chariot Connect modal has the ability to pull information about the donor from their account with the DAF provider. If this feature is enabled, the donor information will be pre-populated in the last pane of the workflow as long as no donor information was passed into Connect via the `onDonationRequest` callback. The user always has the ability to review their information and make changes before submission. This allows for "one-click" checkout experiences and removes the need for a donor to fill out a lengthy form before making a DAF donation. - -Chariot makes no guarantee on the completeness or consistency of the information fetched from the donor's DAF account and serves purely as a convenience feature for donors to expedite the donation experience. In general, Chariot supports fetching donor name, email, and address information. If you require certain information from donors, you will likely need to use the "Continue" flow mentioned above and you can analyze the donor data passed back from the `CHARIOT_SUCCESS` callback and determine if more information is needed before creating the Grant and finalizing the donation. - diff --git a/fern/versions/v1.8/pages/connect-frontend/error-handling-1.mdx b/fern/versions/v1.8/pages/connect-frontend/error-handling-1.mdx deleted file mode 100644 index 83319d8..0000000 --- a/fern/versions/v1.8/pages/connect-frontend/error-handling-1.mdx +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: "Error Handling & Edge Cases" -slug: "error-handling-1" -subtitle: "" -hidden: false -createdAt: "Thu Jun 02 2022 19:47:50 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Wed May 01 2024 21:32:32 GMT+0000 (Coordinated Universal Time)" ---- -### Minimum donation requirement and insufficient account balances - -If a donor tries to submit a grant request for an amount that exceeds their current account balance, Connect will alert the donor and suggest the donor to adjust the donation amount to the available account balance. Additionally, if a Donor Advised Fund platform has a minimum donation requirement, Connect will alert donors of this requirement and suggest the donor to alter the donation size to match the minimum threshold for submission. - - - diff --git a/fern/versions/v1.8/pages/connect-frontend/integrating-connect.mdx b/fern/versions/v1.8/pages/connect-frontend/integrating-connect.mdx deleted file mode 100644 index b3ca2ca..0000000 --- a/fern/versions/v1.8/pages/connect-frontend/integrating-connect.mdx +++ /dev/null @@ -1,254 +0,0 @@ ---- -title: "Integrating Connect (DAFpay)" -slug: "integrating-connect" -subtitle: "Reference for initializing DAFpay using React or JavaScript SDK" -hidden: false -createdAt: "Fri Feb 17 2023 18:02:35 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Fri Jul 12 2024 18:04:07 GMT+0000 (Coordinated Universal Time)" ---- - - **Enable by Default**: DAFpay supports transactions for all eligible 501(c)(3) organizations, allowing DAFpay to function on a donation form prior to the completion of the nonprofit's onboarding with Chariot. Thus, we advise setting DAFpay as a default payment option across your donation pages. This will improve fundraising outcomes and help develop relationships with key donors! - - **Express Checkout Option**: DAFpay offers the capability to automatically gather crucial donor information, such as names, email addresses, physical addresses, and more. Additionally, DAFpay provides Intelligent Donation Recommendations, taking into account factors like the donor's account balance. For this reason, we recommend featuring DAFpay as an Express Checkout option, making it visible early in the donation process, before donors are prompted to input their information or decide on a donation amount. This enhances conversion rates and encourages larger donations. - - Please don't hesitate to contact us with any questions! - - -## Installation - -Chariot Connect (DAFpay button) comes as a small JavaScript package. It can be loaded directly from the Chariot CDN or installed via [NPM](https://www.npmjs.com/package/react-chariot-connect) or Yarn. When loading from the CDN, It must always be loaded directly from [https://cdn.givechariot.com](https://cdn.givechariot.com), rather than included in a bundle or hosted yourself. - - -```html CDN - -``` -```shell NPM -npm install --save react-chariot-connect -``` -```shell Yarn -yarn add react-chariot-connect -``` - - -## Add Chariot Connect - -Chariot provides a simple-to-use web component that allows you to implement the Chariot Connect (DAFpay) button with a single line. Add Chariot-Connect component where you want the DAFpay button to appear. - - -```html HTML - -``` -```javascript React -import React, { useState } from 'react'; -import ChariotConnect from 'react-chariot-connect'; - -const App = () => { - return ( -
- -
- ); -}; -``` - - -A nonprofit's `cid` (Connect ID) should be retrieved from your database after the nonprofit has been registered with Chariot. For now, feel free to use this cid for testing purposes: `test_15b867c559e3c73a80cd69efd115cb928cb9874625291f756f7273446bcd8f88`. - -
- -_Note: For testing purposes in a sandbox environment the following credentials will log in to any DAF provider._ - -``` -username: good-user -password: password123 -``` - -## Pre-populate data into your Connect Session - -Chariot accepts information before it launches a Connect session. To provide this information, leverage the `onDonationRequest` function from the Chariot element. As suggested above, pre-populating this information is completely optional, however you can use metadata if you want to associate the payment or session with any data in your system. - - -```javascript JavaScript -// get the element from the DOM -const chariot = document.getElementById("chariot") - -// provide a callback that returns the donation data -chariot.onDonationRequest(async () => { - return { - amount: 25000, //this is $250.00 USD - firstName: "Michael", - lastName: "Scott", - email: "michaelScott@theoffice.com", - address: { - line1: "123 Main St", - line2: "Suite 4", - city: "New York", - state: "NY", - postalCode: "12345" - }, - metadata: { - fundraiserTag: "marathon" - }, - } -}) -``` -```javascript React -import React, { useState } from 'react'; -import ChariotConnect from 'react-chariot-connect'; - -const App = () => { - const onDonationRequest = () => { - return { - amount: 25000, //this is $250.00 USD - firstName: "Michael", - lastName: "Scott", - email: "michaelScott@theoffice.com", - metadata: { - fundraiserTag: "marathon" - }, - } - } - - return ( -
- -
- ); -}; -``` - - -The given donation data must match the following schema to be accepted by Chariot: - -| Parameter | Description | Type | -|------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------| -| amount | The donation amount in cents. e.g., for a $20 donation, enter 2000.

If this value is not passed in, Chariot will use the user's account balance to recommend a donation amount. This can lead to significantly larger donation amounts. | number (optional) | -| firstName | The donor's first name | string (optional) | -| lastName | The donor's last name | string (optional) | -| email | The donor's email address. Must be in email format | string (optional) | -| phone | The donor's phone number. Please provide the phone number with the country code and without special characters | string (optional) | -| note | A note the donor wants to send to the nonprofit | string (optional) | -| anonymous | Indicates if this donation should be sent anonymously (default: false) | boolean (optional)| -| address | The donor's address: line1, line2, city, state, postalCode | object (optional) | -| metadata | An object with a set of name-value pairs. You can use this object to include any miscellaneous information you want to tie to the workflow session. | object (optional) | -| fundId | The ID of the preselected DAF provider.

If this value is provided, the donor will not be shown the default DAF dropdown and will instead be taken straight to that DAF's login. | string (optional) | - - -## Capture your grant intent - -When a user completes a Chariot Connect session you will receive a grant intent. After you submit your own donation form, don't forget to call the [ Create Grant](/api-reference/grants/create) API to complete the transaction. - -Most workflows proceed as follows: - -1. Listen for the `CHARIOT_SUCCESS` event to receive the grant intent after a Chariot Connect session. - 1. If you would like to collect any additional information from the user such as additional contact information you can do so at this step. If the Chariot Connect session is the last step in your donation form this is not necessary. -2. Submit your own donation form before converting the grant intent into a completed grant. - _Note: Submitting your own donation form before converting the grant ensures consistency between your systems and Chariot._ -3. Have your backend call Chariot's [Create Grant](/api-reference/grants/create) API to complete the grant (and capture the grant intent). - - -```javascript JavaScript -// get the element from the DOM -const chariot = document.getElementById('chariot'); - -chariot.addEventListener('CHARIOT_SUCCESS', ({ detail }) => { - // Record the grant intent information so that you can - // capture the transaction once your form is submitted. -}); -``` -```javascript React -import React, { useState } from 'react'; -import ChariotConnect from 'react-chariot-connect'; - -const App = () => { - const onSuccess = (r) => { - // Record the grant intent information so that you can - // complete the transaction once your form is submitted. - }; - const onExit = (e) => console.log('exit', e); - const onDonationRequest = () => { - // your logic - } - - return ( -
- -
- ); -}; -``` - - -### Response Objects - - -```json onSuccessMetadata -{ - "workflowSessionId":"79e772be-547d-4c9c-8b76-4ac4ed4c441a", //Id of the Connect session - "grantIntent": { - "userFriendlyId": "100020", //The user-friendly identifier for the grant intent - "fundId": "bbf485dd-a056-4a9d-89a8-06e201cdbf7f", //Id of the donor advised fund - "amount": 2000, //The grant amount expressed in units of cents; USD only - "metadata": {} // The same metadata object that was passed in the onDonationRequest callback referenced above - } - -``` -```json onExitMetadata -{ - "workflowSessionId": "79e772be-547d-4c9c-8b76-4ac4ed4c441a", // Id of the Connect workflow session. - "nodeId": "consent-node-id", // The id representing the pane where the user exited the Connect flow. - "fundId": "bbf485dd-a056-4a9d-89a8-06e201cdbf7f", // The id of the donor advised fund that the user selected. - "reason": "USER_EXIT", // An enum giving a reason to why the modal exited. - "description": "User exited the flow" // A human readable string containing a brief sentence explaining the exit reason. -} -``` - - -| Event Name | Description | Metadata Type | -|--------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------| -| `CHARIOT_INIT` | The init event is called when the Chariot Connect script is initialized and ready to be run. This is useful to be able to know when Chariot Connect is initialized and ready to be used. | No metadata is provided for this event. | -| `CHARIOT_SUCCESS` | The success event contains a final summary of the Connect workflow session. It contains the workflow session id and relevant donation information.

Once you receive the success event don't forget to complete the transaction by calling the [Create Grant](/api-reference/grants/create) route. | `OnSuccessMetadata` | -| `CHARIOT_EXIT` | The exit event is called when a user exits without successfully completing the flow, when an error occurs during the flow, or when a user confirms an unintegrated grant. | `OnExitMetadata` | - - -#### Exit Reasons - -```javascript JavaScript -enum ExitReason { - USER_EXIT = "USER_EXIT", // User exited the flow - UNINTEGRATED_DAF = "UNINTEGRATED_DAF", // DAF is not integrated with Chariot - UNINTEGRATED_GRANT_CONFIRMED = "UNINTEGRATED_GRANT_CONFIRMED", // Unintegrated grant confirmed with Chariot - CID_NOT_FOUND = "CID_NOT_FOUND", // Connect Identifier is not found - INELIGIBLE_ORGANIZATION = "INELIGIBLE_ORGANIZATION", // This Organization is not eligible to receive DAF donations - CREDENTIALS_ERROR = "CREDENTIALS_ERROR", // Invalid credentials - INVALID_CARD = "INVALID_CARD", // Invalid card number - TFA_ERROR = "TFA_VERIFICATION_ERROR", // Two-factor authentication error - ZERO_AMOUNT = "ZERO_GRANT_AMOUNT", // Grant amount is zero - SERVICE_DEACTIVATED = "SERVICE_DEACTIVATED", // Nonprofit's Connect is deactivated (active = false) - ACCESS_RESTRICTED = "ACCOUNT_ACCESS_RESTRICTED", // User's DAF sponsor account electronic access is restricted - EIN_NOT_FOUND = "NONPROFIT_NOT_FOUND", // DAF sponsor does not support grants to the Nonprofit - CONNECTION_FAILED = "CONNECTION_FAILED", // Connection to the DAF sponsor failed - SESSION_NOT_FOUND = "SESSION_NOT_FOUND", // User session is not found and may have expired - CUSTOM_ERROR = "CUSTOM_ERROR", // Custom error - INTERNAL_ERROR = "INTERNAL_ERROR", // Internal error - INSTITUTION_DOWN_ERROR = "INSTITUTION_DOWN_ERROR", // DAF sponsor institution is down; user should try again later - NO_CHARITABLE_ACCOUNTS = "NO_CHARITABLE_ACCOUNTS", // Donor has no charitable accounts in the logged in account -} -``` - -## Advanced Customizations - -### Disabling Chariot Connect - -To prevent Connect from initiating until form validation is performed, passing `false` to the onDonationRequest will stop the button from launching. - diff --git a/fern/versions/v1.8/pages/getting-started/faq.mdx b/fern/versions/v1.8/pages/getting-started/faq.mdx deleted file mode 100644 index c89b2ce..0000000 --- a/fern/versions/v1.8/pages/getting-started/faq.mdx +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: "FAQ" -slug: "faq" -subtitle: "Answers to commonly asked questions" -hidden: false -createdAt: "Mon Dec 18 2023 20:30:30 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Wed Mar 27 2024 18:04:44 GMT+0000 (Coordinated Universal Time)" ---- -### How can my platform collect our processing fees? - -In the [Create Grant](/api-reference/grants/create) endpoint, there is a parameter named `applicationFeeAmount`. This will allow the caller to pass in a processing fee for the grant. Chariot will then either deduct that amount before paying out the nonprofit or invoice the fees from the Nonprofit and send the fees in a cadence according to an agreed-upon contract. - -### How can I run form validations before the Connect button launches? - -To perform form validation before Chariot Connect launches, simply return `false` in the onDonationRequest. Please see [Integrating Connect](/integrating-connect) to learn more. - -### How can donors cover fees? - -If a donor wishes to cover the fees, increase the final amount sent to the [Create Grant](/api-reference/grants/create) route to compensate for the processing fees. Take into consideration that increasing the final amount also raises the processing fee and **don't forget to round the final amount to a whole dollar (nearest 100) as DAFs only allow grants in dollar increments**. - -To calculate the final amount you can use the following formula: - - - - -### What is the DAFpay Network? - -For nonprofits that haven't completed onboarding and verification with Chariot, DAFpay routes payments through a 501(c)(3) nonprofit entity named [DAFpay Network](https://www.dafpaynetwork.org/). The DAFpay Network then sends the funds to the nonprofit minus processing fees. This enables DAFpay to accommodate payments to all eligible 501(c)(3) nonprofits for receiving DAF (Donor-Advised Fund) donations. - - - diff --git a/fern/versions/v1.8/pages/getting-started/how-chariot-works.mdx b/fern/versions/v1.8/pages/getting-started/how-chariot-works.mdx deleted file mode 100644 index dcd3aed..0000000 --- a/fern/versions/v1.8/pages/getting-started/how-chariot-works.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: "Overview" -slug: "how-chariot-works" -subtitle: "A quick introduction to integrating DAFpay" -hidden: false -createdAt: "Sun May 21 2023 20:36:07 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Wed May 01 2024 21:30:05 GMT+0000 (Coordinated Universal Time)" ---- - - - -# Introduction - -DAFpay is a payment option that enables donors to complete transactions using their Donor-Advised Fund (DAF). - -### Features and Advantages of DAFpay: - -1. **Universal Support for Nonprofits**: DAFpay enables donors to support any nonprofit organization eligible to receive DAF gifts, thus facilitating grants to a wide range of eligible nonprofits. -2. **Express Checkout**: By retrieving donor information automatically, DAFpay eliminates the need for donors to enter their contact details on donation forms, thereby simplifying the donation process and enhancing conversion rates. For most scenarios, DAFpay can auto-fill details such as the donor's name, email, address, and phone number. -3. **Intelligent Donation Recommendations**: DAFpay suggests donation amounts calculated from the donor's account balance and other key factors, encouraging larger donations. On average, donations made through DAFpay exceed $1,000. - -DAFpay manages the entire grant submission process, including credential verification, multi-factor authentication, error management, and fee collection, for each Donor Advised Fund supported. - -## How it works - -The initial step involves **registering** each nonprofit organization. Once registered, you will receive a Connect ID (CID) that can be used to **initialize** Connect, the web component that renders the DAFpay button. Lastly, **query** Chariot's APIs to gather all the data generated through Connect. - - - - -## Try it out! - -Try out the [Chariot Demo](https://app.givechariot.com/demo) for yourself and see what it might look like on your website after you've completed the integration. - diff --git a/fern/versions/v1.8/pages/getting-started/navigating-the-docs.mdx b/fern/versions/v1.8/pages/getting-started/navigating-the-docs.mdx deleted file mode 100644 index a22575b..0000000 --- a/fern/versions/v1.8/pages/getting-started/navigating-the-docs.mdx +++ /dev/null @@ -1,13 +0,0 @@ ---- -title: "Navigating the Docs" -slug: "navigating-the-docs" -subtitle: "" -hidden: false -createdAt: "Sun May 21 2023 20:37:56 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Wed Jan 31 2024 01:46:58 GMT+0000 (Coordinated Universal Time)" ---- -The Chariot documentation is broken up into two main parts: - -1. [Chariot Connect](integrating-connect): The frontend, client-side component that launches [DAFPay](https://www.dafpay.com/): the application that users interact with in order to initiate grant requests from their Donor Advised Funds. Both React and Javascript SDKs are available. -2. [Chariot API](overview): The backend endpoints needed to register new nonprofits, submit grants, and query for transactional data and events. All endpoints much be authenticated using OAuth 2.0 Client Credentials Flow. - diff --git a/fern/versions/v1.8/pages/getting-started/quickstart.mdx b/fern/versions/v1.8/pages/getting-started/quickstart.mdx deleted file mode 100644 index bd70e37..0000000 --- a/fern/versions/v1.8/pages/getting-started/quickstart.mdx +++ /dev/null @@ -1,182 +0,0 @@ ---- -title: "Quick Start" -slug: "quickstart" -subtitle: "" -hidden: false -createdAt: "Wed Jan 04 2023 20:44:11 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Wed Mar 27 2024 22:59:22 GMT+0000 (Coordinated Universal Time)" ---- -This guide will help you get up and running making your first Chariot API call in just a few minutes. You will create an access token, get a CID for a nonprofit, and query for the grants of that CID. - - -This guide assumes you have already been shared a `client_id` and `client_secret`. If that is not the case, please email [support@givechariot.com](mailto:support@givechariot.com). - - -## 1. Generate an access token 🔑 - -First, you'll need to create an access token that lets you access the APIs. Fill in the provided client_id and client_secret to in the preferred code snippet and get an access token. - - -```curl cURL -curl --request POST \ - --url 'https://chariot-sandbox.us.auth0.com/oauth/token' \ - --header 'content-type: application/x-www-form-urlencoded' \ - --data 'audience=https://api.givechariot.com&grant_type=client_credentials&client_id=YOUR_CLIENT_ID&client_secret=YOUR_CLIENT_SECRET' -``` -```http HTTP -POST https://chariot-sandbox.us.auth0.com/oauth/token -Content-Type: application/x-www-form-urlencoded - -audience=https://api.givechariot.com&grant_type=client_credentials&client_id=YOUR_CLIENT_ID&client_secret=YOUR_CLIENT_SECRET -``` -```javascript JavaScript -var request = require("request"); - -var options = { method: 'POST', - url: 'https://chariot-sandbox.us.auth0.com/oauth/token', - headers: { 'content-type': 'application/x-www-form-urlencoded' }, - form: - { client_id: 'YOUR_CLIENT_ID', - client_secret: 'YOUR_CLIENT_SECRET', - audience: 'https://api.givechariot.com', - grant_type: 'client_credentials' } - }; - -request(options, function (error, response, body) { - if (error) throw new Error(error); - - console.log(body); -}); -``` - - -## 2. Create a CID for a nonprofit 🪪 - -Now that you have an access token, you're set to initiate an API request. We're going to utilize Chariot's APIs to generate a CID (Connect Identifier) for a nonprofit organization. This CID is a crucial element needed to activate the DAFpay button. - -To create a CID to a nonprofit, we first establish the nonprofit's ID by utilizing their EIN (Employer Identification Number). Following that, we proceed to create a Connect with the nonprofit's ID. - -### 2a. Create Nonprofit :hospital: - -The [Create nonprofit](/api-reference/nonprofits/create) endpoint registers a new nonprofit or confirms its existence within the Chariot system. - -For registration, it's necessary to supply the nonprofit's EIN and details for a contact person at the nonprofit for Chariot's customer support purposes. - -Below are a few examples of different implementations. Modify the `user` object, `ein` field, and access token from step 1 before making the request. - - -```curl cURL -curl --request POST \ - --url https://sandboxapi.givechariot.com/v1/nonprofits \ - --header 'accept: application/json' \ - --header 'authorization: Bearer ACCESS_TOKEN' \ - --header 'content-type: application/json' \ - --data ' -{ - "user": { - "email": "hansolo@savethestars.com", - "phone": "3051234321", - "firstName": "Han", - "lastName": "Solo" - }, - "ein": "123456789" -} -' -``` -```javascript JavaScript -const options = { - method: 'POST', - headers: { - accept: 'application/json', - 'content-type': 'application/json', - authorization: 'Bearer ' - }, - body: JSON.stringify({ - user: { - email: 'hansolo@savethestars.com', - phone: '3051234321', - firstName: 'Han', - lastName: 'Solo' - }, - ein: '123456789' - }) -}; - -fetch('https://sandboxapi.givechariot.com/v1/nonprofits', options) - .then(response => response.json()) - .then(response => console.log(response)) - .catch(err => console.error(err)); -``` - - -Bravo! You have just created a nonprofit in the Chariot system. Mark down the nonprofit's `id` and now let's create a Connect for this nonprofit. - -### 2b. Create Connect 🪪 - -The [Create Connect](/api-reference/connects/create) endpoint creates a Connect record or retrieves it if a Connect already exists for this nonprofit in Chariot's system. - -To create a Connect, the nonprofit's `id` must be provided, which you should have from the previous step! - -Below are a few examples of different implementations. Modify the `NONPROFIT_ID` query parameter with the nonprofit's `id`. Don't forget to add the access_token! - - -```curl cURL -curl --request POST \ - --url 'https://sandboxapi.givechariot.com/v1/connects?nonprofit=NONPROFIT_ID' \ - --header 'accept: application/json' \ - --header 'authorization: Bearer ACCESS_TOKEN' \ - --header 'content-type: application/json' -``` -```javascript JavaScript -const options = { - method: 'POST', - headers: { - accept: 'application/json', - 'content-type': 'application/json', - authorization: 'Bearer YOUR_TOKEN_FROM_STEP_1_HERE' - } -}; - -fetch('https://sandboxapi.givechariot.com/v1/connects?nonprofit=NONPROFIT_ID', options) - .then(response => response.json()) - .then(response => console.log(response)) - .catch(err => console.error(err)); -``` - - -Amazing! You can now start [Integrating Connect](integrating-connect) to build a front end and start receiving grants for this nonprofit. - -## 3. List Grants 💵 - -After submitting several grants through Chariot Connect, you can access Chariot's APIs to retrieve information on those grants. - -The [List Grants](/api-reference/grants/list) endpoint lists all the grants for a particular CID. - -To retrieve grants, you must supply the API key of the Connect. You can obtain the API Key by using the [Get Connect](/api-reference/connects/get)endpoint or by noting it down from the setup process when you initially created the Connect. - -Now we are ready to list grants. Below are a few examples of different implementations. Modify the `API_KEY` with the Connect's API key. Don't forget to add the access_token! - - -```curl cURL -curl --request GET \ - --url 'https://sandboxapi.givechariot.com/v1/grants?pageLimit=10' \ - --header 'accept: application/json' \ - --header 'authorization: Bearer ACCESS_TOKEN' \ - --header 'x-chariot-api-key: API_KEY' -``` -```javascript JavaScript -const options = { - method: 'GET', - headers: { - accept: 'application/json', - authorization: 'Bearer YOUR_TOKEN_FROM_STEP_1_HERE', - 'x-chariot-api-key': 'API_KEY' - } -}; - -fetch('https://sandboxapi.givechariot.com/v1/grants?pageLimit=10', options) - .then(response => response.json()) - .then(response => console.log(response)) - .catch(err => console.error(err)); -``` - diff --git a/fern/versions/v1.8/pages/rest-api/api-reference-1.mdx b/fern/versions/v1.8/pages/rest-api/api-reference-1.mdx deleted file mode 100644 index 5e6e5c5..0000000 --- a/fern/versions/v1.8/pages/rest-api/api-reference-1.mdx +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: "API Reference" -slug: "api-reference-1" -subtitle: "" -hidden: false -metadata: - image: [] - robots: "index" -createdAt: "Thu Jun 02 2022 00:03:16 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Thu Jun 02 2022 00:03:19 GMT+0000 (Coordinated Universal Time)" -type: "link" -link_url: "https://givechariot.readme.io/reference/overview" ---- - diff --git a/fern/versions/v2.0/docs.yml b/fern/versions/v1/docs.yml similarity index 100% rename from fern/versions/v2.0/docs.yml rename to fern/versions/v1/docs.yml diff --git a/fern/versions/v1.7/images/15e7e65-Error-handling-picture.png b/fern/versions/v1/images/15e7e65-Error-handling-picture.png similarity index 100% rename from fern/versions/v1.7/images/15e7e65-Error-handling-picture.png rename to fern/versions/v1/images/15e7e65-Error-handling-picture.png diff --git a/fern/versions/v1.7/images/36d8373-dafpay-auth.png b/fern/versions/v1/images/36d8373-dafpay-auth.png similarity index 100% rename from fern/versions/v1.7/images/36d8373-dafpay-auth.png rename to fern/versions/v1/images/36d8373-dafpay-auth.png diff --git a/fern/versions/v1.7/images/41e910d-Group_549.png b/fern/versions/v1/images/41e910d-Group_549.png similarity index 100% rename from fern/versions/v1.7/images/41e910d-Group_549.png rename to fern/versions/v1/images/41e910d-Group_549.png diff --git a/fern/versions/v1.7/images/446fbf1-Gradient.svg b/fern/versions/v1/images/446fbf1-Gradient.svg similarity index 100% rename from fern/versions/v1.7/images/446fbf1-Gradient.svg rename to fern/versions/v1/images/446fbf1-Gradient.svg diff --git a/fern/versions/v1.7/images/57a9b45-api-manual-graphic.png b/fern/versions/v1/images/57a9b45-api-manual-graphic.png similarity index 100% rename from fern/versions/v1.7/images/57a9b45-api-manual-graphic.png rename to fern/versions/v1/images/57a9b45-api-manual-graphic.png diff --git a/fern/versions/v1.7/images/68157f8-lagrida_latex_editor.png b/fern/versions/v1/images/68157f8-lagrida_latex_editor.png similarity index 100% rename from fern/versions/v1.7/images/68157f8-lagrida_latex_editor.png rename to fern/versions/v1/images/68157f8-lagrida_latex_editor.png diff --git a/fern/versions/v1.7/images/8155407-DefaultTheme.svg b/fern/versions/v1/images/8155407-DefaultTheme.svg similarity index 100% rename from fern/versions/v1.7/images/8155407-DefaultTheme.svg rename to fern/versions/v1/images/8155407-DefaultTheme.svg diff --git a/fern/versions/v1.7/images/9339d40-Connect-no-words.png b/fern/versions/v1/images/9339d40-Connect-no-words.png similarity index 100% rename from fern/versions/v1.7/images/9339d40-Connect-no-words.png rename to fern/versions/v1/images/9339d40-Connect-no-words.png diff --git a/fern/versions/v1.7/images/9c06770-LightBlue.svg b/fern/versions/v1/images/9c06770-LightBlue.svg similarity index 100% rename from fern/versions/v1.7/images/9c06770-LightBlue.svg rename to fern/versions/v1/images/9c06770-LightBlue.svg diff --git a/fern/versions/v2.0/images/SchwabGrantLetter.png b/fern/versions/v1/images/SchwabGrantLetter.png similarity index 100% rename from fern/versions/v2.0/images/SchwabGrantLetter.png rename to fern/versions/v1/images/SchwabGrantLetter.png diff --git a/fern/versions/v1.7/images/a080c51-api_doc_image.png b/fern/versions/v1/images/a080c51-api_doc_image.png similarity index 100% rename from fern/versions/v1.7/images/a080c51-api_doc_image.png rename to fern/versions/v1/images/a080c51-api_doc_image.png diff --git a/fern/versions/v1.7/images/a750cf5-API_Docs_Overview_Diagram.png b/fern/versions/v1/images/a750cf5-API_Docs_Overview_Diagram.png similarity index 100% rename from fern/versions/v1.7/images/a750cf5-API_Docs_Overview_Diagram.png rename to fern/versions/v1/images/a750cf5-API_Docs_Overview_Diagram.png diff --git a/fern/versions/v1.7/images/a7b65c5-LightMode.svg b/fern/versions/v1/images/a7b65c5-LightMode.svg similarity index 100% rename from fern/versions/v1.7/images/a7b65c5-LightMode.svg rename to fern/versions/v1/images/a7b65c5-LightMode.svg diff --git a/fern/versions/v1.7/images/acf7ea5-Overview.png b/fern/versions/v1/images/acf7ea5-Overview.png similarity index 100% rename from fern/versions/v1.7/images/acf7ea5-Overview.png rename to fern/versions/v1/images/acf7ea5-Overview.png diff --git a/fern/versions/v2.0/images/chariot_dashboard_reconciliation.png b/fern/versions/v1/images/chariot_dashboard_reconciliation.png similarity index 100% rename from fern/versions/v2.0/images/chariot_dashboard_reconciliation.png rename to fern/versions/v1/images/chariot_dashboard_reconciliation.png diff --git a/fern/versions/v1.7/images/f0b81b5-FLOW-OF-FUNDS-APIS.png b/fern/versions/v1/images/f0b81b5-FLOW-OF-FUNDS-APIS.png similarity index 100% rename from fern/versions/v1.7/images/f0b81b5-FLOW-OF-FUNDS-APIS.png rename to fern/versions/v1/images/f0b81b5-FLOW-OF-FUNDS-APIS.png diff --git a/fern/versions/v2.0/images/paypal_grant_dashboard.png b/fern/versions/v1/images/paypal_grant_dashboard.png similarity index 100% rename from fern/versions/v2.0/images/paypal_grant_dashboard.png rename to fern/versions/v1/images/paypal_grant_dashboard.png diff --git a/fern/versions/v2.0/pages/api-backend/authentication-1.mdx b/fern/versions/v1/pages/api-backend/authentication-1.mdx similarity index 100% rename from fern/versions/v2.0/pages/api-backend/authentication-1.mdx rename to fern/versions/v1/pages/api-backend/authentication-1.mdx diff --git a/fern/versions/v2.0/pages/api-backend/errors-1.mdx b/fern/versions/v1/pages/api-backend/errors-1.mdx similarity index 100% rename from fern/versions/v2.0/pages/api-backend/errors-1.mdx rename to fern/versions/v1/pages/api-backend/errors-1.mdx diff --git a/fern/versions/v1.7/pages/api-backend/grant-statuses.mdx b/fern/versions/v1/pages/api-backend/grant-statuses.mdx similarity index 100% rename from fern/versions/v1.7/pages/api-backend/grant-statuses.mdx rename to fern/versions/v1/pages/api-backend/grant-statuses.mdx diff --git a/fern/versions/v2.0/pages/api-backend/overview.mdx b/fern/versions/v1/pages/api-backend/overview.mdx similarity index 100% rename from fern/versions/v2.0/pages/api-backend/overview.mdx rename to fern/versions/v1/pages/api-backend/overview.mdx diff --git a/fern/versions/v1.7/pages/api-backend/postman.mdx b/fern/versions/v1/pages/api-backend/postman.mdx similarity index 100% rename from fern/versions/v1.7/pages/api-backend/postman.mdx rename to fern/versions/v1/pages/api-backend/postman.mdx diff --git a/fern/versions/v1.8/pages/api-backend/webhooks-and-events.mdx b/fern/versions/v1/pages/api-backend/webhooks-and-events.mdx similarity index 100% rename from fern/versions/v1.8/pages/api-backend/webhooks-and-events.mdx rename to fern/versions/v1/pages/api-backend/webhooks-and-events.mdx diff --git a/fern/versions/v1.7/pages/chariot-api/connects-1.mdx b/fern/versions/v1/pages/chariot-api/connects-1.mdx similarity index 100% rename from fern/versions/v1.7/pages/chariot-api/connects-1.mdx rename to fern/versions/v1/pages/chariot-api/connects-1.mdx diff --git a/fern/versions/v1.7/pages/chariot-api/connects-1/create-connect.mdx b/fern/versions/v1/pages/chariot-api/connects-1/create-connect.mdx similarity index 100% rename from fern/versions/v1.7/pages/chariot-api/connects-1/create-connect.mdx rename to fern/versions/v1/pages/chariot-api/connects-1/create-connect.mdx diff --git a/fern/versions/v1.7/pages/chariot-api/connects-1/get-connect.mdx b/fern/versions/v1/pages/chariot-api/connects-1/get-connect.mdx similarity index 100% rename from fern/versions/v1.7/pages/chariot-api/connects-1/get-connect.mdx rename to fern/versions/v1/pages/chariot-api/connects-1/get-connect.mdx diff --git a/fern/versions/v1.7/pages/chariot-api/dafs-1.mdx b/fern/versions/v1/pages/chariot-api/dafs-1.mdx similarity index 100% rename from fern/versions/v1.7/pages/chariot-api/dafs-1.mdx rename to fern/versions/v1/pages/chariot-api/dafs-1.mdx diff --git a/fern/versions/v1.7/pages/chariot-api/dafs-1/get-daf.mdx b/fern/versions/v1/pages/chariot-api/dafs-1/get-daf.mdx similarity index 100% rename from fern/versions/v1.7/pages/chariot-api/dafs-1/get-daf.mdx rename to fern/versions/v1/pages/chariot-api/dafs-1/get-daf.mdx diff --git a/fern/versions/v1.7/pages/chariot-api/dafs-1/list-dafs.mdx b/fern/versions/v1/pages/chariot-api/dafs-1/list-dafs.mdx similarity index 100% rename from fern/versions/v1.7/pages/chariot-api/dafs-1/list-dafs.mdx rename to fern/versions/v1/pages/chariot-api/dafs-1/list-dafs.mdx diff --git a/fern/versions/v1.7/pages/chariot-api/event-subscriptions.mdx b/fern/versions/v1/pages/chariot-api/event-subscriptions.mdx similarity index 100% rename from fern/versions/v1.7/pages/chariot-api/event-subscriptions.mdx rename to fern/versions/v1/pages/chariot-api/event-subscriptions.mdx diff --git a/fern/versions/v1.7/pages/chariot-api/event-subscriptions/createeventsubscription.mdx b/fern/versions/v1/pages/chariot-api/event-subscriptions/createeventsubscription.mdx similarity index 100% rename from fern/versions/v1.7/pages/chariot-api/event-subscriptions/createeventsubscription.mdx rename to fern/versions/v1/pages/chariot-api/event-subscriptions/createeventsubscription.mdx diff --git a/fern/versions/v1.7/pages/chariot-api/event-subscriptions/geteventsubscription.mdx b/fern/versions/v1/pages/chariot-api/event-subscriptions/geteventsubscription.mdx similarity index 100% rename from fern/versions/v1.7/pages/chariot-api/event-subscriptions/geteventsubscription.mdx rename to fern/versions/v1/pages/chariot-api/event-subscriptions/geteventsubscription.mdx diff --git a/fern/versions/v1.7/pages/chariot-api/event-subscriptions/listeventsubscriptions.mdx b/fern/versions/v1/pages/chariot-api/event-subscriptions/listeventsubscriptions.mdx similarity index 100% rename from fern/versions/v1.7/pages/chariot-api/event-subscriptions/listeventsubscriptions.mdx rename to fern/versions/v1/pages/chariot-api/event-subscriptions/listeventsubscriptions.mdx diff --git a/fern/versions/v1.7/pages/chariot-api/event-subscriptions/updateeventsubscription.mdx b/fern/versions/v1/pages/chariot-api/event-subscriptions/updateeventsubscription.mdx similarity index 100% rename from fern/versions/v1.7/pages/chariot-api/event-subscriptions/updateeventsubscription.mdx rename to fern/versions/v1/pages/chariot-api/event-subscriptions/updateeventsubscription.mdx diff --git a/fern/versions/v1.7/pages/chariot-api/events-1.mdx b/fern/versions/v1/pages/chariot-api/events-1.mdx similarity index 100% rename from fern/versions/v1.7/pages/chariot-api/events-1.mdx rename to fern/versions/v1/pages/chariot-api/events-1.mdx diff --git a/fern/versions/v1.7/pages/chariot-api/events-1/getevent.mdx b/fern/versions/v1/pages/chariot-api/events-1/getevent.mdx similarity index 100% rename from fern/versions/v1.7/pages/chariot-api/events-1/getevent.mdx rename to fern/versions/v1/pages/chariot-api/events-1/getevent.mdx diff --git a/fern/versions/v1.7/pages/chariot-api/events-1/listevents.mdx b/fern/versions/v1/pages/chariot-api/events-1/listevents.mdx similarity index 100% rename from fern/versions/v1.7/pages/chariot-api/events-1/listevents.mdx rename to fern/versions/v1/pages/chariot-api/events-1/listevents.mdx diff --git a/fern/versions/v1.7/pages/chariot-api/grants-1.mdx b/fern/versions/v1/pages/chariot-api/grants-1.mdx similarity index 100% rename from fern/versions/v1.7/pages/chariot-api/grants-1.mdx rename to fern/versions/v1/pages/chariot-api/grants-1.mdx diff --git a/fern/versions/v1.8/pages/chariot-api/grants-1/create-grant.mdx b/fern/versions/v1/pages/chariot-api/grants-1/create-grant.mdx similarity index 100% rename from fern/versions/v1.8/pages/chariot-api/grants-1/create-grant.mdx rename to fern/versions/v1/pages/chariot-api/grants-1/create-grant.mdx diff --git a/fern/versions/v2.0/pages/chariot-api/grants-1/create-recurring-grant.mdx b/fern/versions/v1/pages/chariot-api/grants-1/create-recurring-grant.mdx similarity index 100% rename from fern/versions/v2.0/pages/chariot-api/grants-1/create-recurring-grant.mdx rename to fern/versions/v1/pages/chariot-api/grants-1/create-recurring-grant.mdx diff --git a/fern/versions/v1.7/pages/chariot-api/grants-1/get-grant.mdx b/fern/versions/v1/pages/chariot-api/grants-1/get-grant.mdx similarity index 100% rename from fern/versions/v1.7/pages/chariot-api/grants-1/get-grant.mdx rename to fern/versions/v1/pages/chariot-api/grants-1/get-grant.mdx diff --git a/fern/versions/v2.0/pages/chariot-api/grants-1/get-recurring-grant.mdx b/fern/versions/v1/pages/chariot-api/grants-1/get-recurring-grant.mdx similarity index 100% rename from fern/versions/v2.0/pages/chariot-api/grants-1/get-recurring-grant.mdx rename to fern/versions/v1/pages/chariot-api/grants-1/get-recurring-grant.mdx diff --git a/fern/versions/v1.7/pages/chariot-api/grants-1/get-unintegrated-grant.mdx b/fern/versions/v1/pages/chariot-api/grants-1/get-unintegrated-grant.mdx similarity index 100% rename from fern/versions/v1.7/pages/chariot-api/grants-1/get-unintegrated-grant.mdx rename to fern/versions/v1/pages/chariot-api/grants-1/get-unintegrated-grant.mdx diff --git a/fern/versions/v1.7/pages/chariot-api/grants-1/list-grants.mdx b/fern/versions/v1/pages/chariot-api/grants-1/list-grants.mdx similarity index 100% rename from fern/versions/v1.7/pages/chariot-api/grants-1/list-grants.mdx rename to fern/versions/v1/pages/chariot-api/grants-1/list-grants.mdx diff --git a/fern/versions/v2.0/pages/chariot-api/grants-1/list-recurring-grants.mdx b/fern/versions/v1/pages/chariot-api/grants-1/list-recurring-grants.mdx similarity index 100% rename from fern/versions/v2.0/pages/chariot-api/grants-1/list-recurring-grants.mdx rename to fern/versions/v1/pages/chariot-api/grants-1/list-recurring-grants.mdx diff --git a/fern/versions/v1.7/pages/chariot-api/grants-1/list-unintegrated-grants.mdx b/fern/versions/v1/pages/chariot-api/grants-1/list-unintegrated-grants.mdx similarity index 100% rename from fern/versions/v1.7/pages/chariot-api/grants-1/list-unintegrated-grants.mdx rename to fern/versions/v1/pages/chariot-api/grants-1/list-unintegrated-grants.mdx diff --git a/fern/versions/v1.7/pages/chariot-api/grants-1/update-grant.mdx b/fern/versions/v1/pages/chariot-api/grants-1/update-grant.mdx similarity index 100% rename from fern/versions/v1.7/pages/chariot-api/grants-1/update-grant.mdx rename to fern/versions/v1/pages/chariot-api/grants-1/update-grant.mdx diff --git a/fern/versions/v1.7/pages/chariot-api/grants-1/update-unintegrated-grant.mdx b/fern/versions/v1/pages/chariot-api/grants-1/update-unintegrated-grant.mdx similarity index 100% rename from fern/versions/v1.7/pages/chariot-api/grants-1/update-unintegrated-grant.mdx rename to fern/versions/v1/pages/chariot-api/grants-1/update-unintegrated-grant.mdx diff --git a/fern/versions/v1.7/pages/chariot-api/nonprofits-1.mdx b/fern/versions/v1/pages/chariot-api/nonprofits-1.mdx similarity index 100% rename from fern/versions/v1.7/pages/chariot-api/nonprofits-1.mdx rename to fern/versions/v1/pages/chariot-api/nonprofits-1.mdx diff --git a/fern/versions/v1.7/pages/chariot-api/nonprofits-1/create-nonprofit.mdx b/fern/versions/v1/pages/chariot-api/nonprofits-1/create-nonprofit.mdx similarity index 100% rename from fern/versions/v1.7/pages/chariot-api/nonprofits-1/create-nonprofit.mdx rename to fern/versions/v1/pages/chariot-api/nonprofits-1/create-nonprofit.mdx diff --git a/fern/versions/v1.7/pages/chariot-api/nonprofits-1/get-nonprofit-by-ein.mdx b/fern/versions/v1/pages/chariot-api/nonprofits-1/get-nonprofit-by-ein.mdx similarity index 100% rename from fern/versions/v1.7/pages/chariot-api/nonprofits-1/get-nonprofit-by-ein.mdx rename to fern/versions/v1/pages/chariot-api/nonprofits-1/get-nonprofit-by-ein.mdx diff --git a/fern/versions/v1.7/pages/chariot-api/nonprofits-1/get-nonprofit-by-id.mdx b/fern/versions/v1/pages/chariot-api/nonprofits-1/get-nonprofit-by-id.mdx similarity index 100% rename from fern/versions/v1.7/pages/chariot-api/nonprofits-1/get-nonprofit-by-id.mdx rename to fern/versions/v1/pages/chariot-api/nonprofits-1/get-nonprofit-by-id.mdx diff --git a/fern/versions/v1.7/pages/chariot-connect/chariot-connect-overview.mdx b/fern/versions/v1/pages/chariot-connect/chariot-connect-overview.mdx similarity index 100% rename from fern/versions/v1.7/pages/chariot-connect/chariot-connect-overview.mdx rename to fern/versions/v1/pages/chariot-connect/chariot-connect-overview.mdx diff --git a/fern/versions/v1.7/pages/chariot-connect/connect-for-web.mdx b/fern/versions/v1/pages/chariot-connect/connect-for-web.mdx similarity index 100% rename from fern/versions/v1.7/pages/chariot-connect/connect-for-web.mdx rename to fern/versions/v1/pages/chariot-connect/connect-for-web.mdx diff --git a/fern/versions/v1.7/pages/chariot-connect/error-handling.mdx b/fern/versions/v1/pages/chariot-connect/error-handling.mdx similarity index 100% rename from fern/versions/v1.7/pages/chariot-connect/error-handling.mdx rename to fern/versions/v1/pages/chariot-connect/error-handling.mdx diff --git a/fern/versions/v2.0/pages/connect-frontend/button-styles.mdx b/fern/versions/v1/pages/connect-frontend/button-styles.mdx similarity index 100% rename from fern/versions/v2.0/pages/connect-frontend/button-styles.mdx rename to fern/versions/v1/pages/connect-frontend/button-styles.mdx diff --git a/fern/versions/v2.0/pages/connect-frontend/configurations.mdx b/fern/versions/v1/pages/connect-frontend/configurations.mdx similarity index 100% rename from fern/versions/v2.0/pages/connect-frontend/configurations.mdx rename to fern/versions/v1/pages/connect-frontend/configurations.mdx diff --git a/fern/versions/v1.7/pages/connect-frontend/error-handling-1.mdx b/fern/versions/v1/pages/connect-frontend/error-handling-1.mdx similarity index 100% rename from fern/versions/v1.7/pages/connect-frontend/error-handling-1.mdx rename to fern/versions/v1/pages/connect-frontend/error-handling-1.mdx diff --git a/fern/versions/v2.0/pages/connect-frontend/integrating-connect.mdx b/fern/versions/v1/pages/connect-frontend/integrating-connect.mdx similarity index 100% rename from fern/versions/v2.0/pages/connect-frontend/integrating-connect.mdx rename to fern/versions/v1/pages/connect-frontend/integrating-connect.mdx diff --git a/fern/versions/v2.0/pages/getting-started/faq.mdx b/fern/versions/v1/pages/getting-started/faq.mdx similarity index 100% rename from fern/versions/v2.0/pages/getting-started/faq.mdx rename to fern/versions/v1/pages/getting-started/faq.mdx diff --git a/fern/versions/v2.0/pages/getting-started/how-chariot-works.mdx b/fern/versions/v1/pages/getting-started/how-chariot-works.mdx similarity index 100% rename from fern/versions/v2.0/pages/getting-started/how-chariot-works.mdx rename to fern/versions/v1/pages/getting-started/how-chariot-works.mdx diff --git a/fern/versions/v1.7/pages/getting-started/navigating-the-docs.mdx b/fern/versions/v1/pages/getting-started/navigating-the-docs.mdx similarity index 100% rename from fern/versions/v1.7/pages/getting-started/navigating-the-docs.mdx rename to fern/versions/v1/pages/getting-started/navigating-the-docs.mdx diff --git a/fern/versions/v2.0/pages/getting-started/quickstart.mdx b/fern/versions/v1/pages/getting-started/quickstart.mdx similarity index 100% rename from fern/versions/v2.0/pages/getting-started/quickstart.mdx rename to fern/versions/v1/pages/getting-started/quickstart.mdx diff --git a/fern/versions/v1.7/pages/rest-api/api-reference-1.mdx b/fern/versions/v1/pages/rest-api/api-reference-1.mdx similarity index 100% rename from fern/versions/v1.7/pages/rest-api/api-reference-1.mdx rename to fern/versions/v1/pages/rest-api/api-reference-1.mdx diff --git a/fern/versions/v2.0/images/15e7e65-Error-handling-picture.png b/fern/versions/v2.0/images/15e7e65-Error-handling-picture.png deleted file mode 100644 index 8345dca..0000000 Binary files a/fern/versions/v2.0/images/15e7e65-Error-handling-picture.png and /dev/null differ diff --git a/fern/versions/v2.0/images/36d8373-dafpay-auth.png b/fern/versions/v2.0/images/36d8373-dafpay-auth.png deleted file mode 100644 index b7c9422..0000000 Binary files a/fern/versions/v2.0/images/36d8373-dafpay-auth.png and /dev/null differ diff --git a/fern/versions/v2.0/images/41e910d-Group_549.png b/fern/versions/v2.0/images/41e910d-Group_549.png deleted file mode 100644 index 8ea0662..0000000 Binary files a/fern/versions/v2.0/images/41e910d-Group_549.png and /dev/null differ diff --git a/fern/versions/v2.0/images/446fbf1-Gradient.svg b/fern/versions/v2.0/images/446fbf1-Gradient.svg deleted file mode 100644 index ee489e1..0000000 --- a/fern/versions/v2.0/images/446fbf1-Gradient.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/fern/versions/v2.0/images/57a9b45-api-manual-graphic.png b/fern/versions/v2.0/images/57a9b45-api-manual-graphic.png deleted file mode 100644 index 2418f9a..0000000 Binary files a/fern/versions/v2.0/images/57a9b45-api-manual-graphic.png and /dev/null differ diff --git a/fern/versions/v2.0/images/68157f8-lagrida_latex_editor.png b/fern/versions/v2.0/images/68157f8-lagrida_latex_editor.png deleted file mode 100644 index 45dd1ba..0000000 Binary files a/fern/versions/v2.0/images/68157f8-lagrida_latex_editor.png and /dev/null differ diff --git a/fern/versions/v2.0/images/8155407-DefaultTheme.svg b/fern/versions/v2.0/images/8155407-DefaultTheme.svg deleted file mode 100644 index 063b2b3..0000000 --- a/fern/versions/v2.0/images/8155407-DefaultTheme.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/fern/versions/v2.0/images/9339d40-Connect-no-words.png b/fern/versions/v2.0/images/9339d40-Connect-no-words.png deleted file mode 100644 index cc052f3..0000000 Binary files a/fern/versions/v2.0/images/9339d40-Connect-no-words.png and /dev/null differ diff --git a/fern/versions/v2.0/images/9c06770-LightBlue.svg b/fern/versions/v2.0/images/9c06770-LightBlue.svg deleted file mode 100644 index 8a73fd0..0000000 --- a/fern/versions/v2.0/images/9c06770-LightBlue.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/fern/versions/v2.0/images/a080c51-api_doc_image.png b/fern/versions/v2.0/images/a080c51-api_doc_image.png deleted file mode 100644 index 09fb77f..0000000 Binary files a/fern/versions/v2.0/images/a080c51-api_doc_image.png and /dev/null differ diff --git a/fern/versions/v2.0/images/a750cf5-API_Docs_Overview_Diagram.png b/fern/versions/v2.0/images/a750cf5-API_Docs_Overview_Diagram.png deleted file mode 100644 index cff27ae..0000000 Binary files a/fern/versions/v2.0/images/a750cf5-API_Docs_Overview_Diagram.png and /dev/null differ diff --git a/fern/versions/v2.0/images/a7b65c5-LightMode.svg b/fern/versions/v2.0/images/a7b65c5-LightMode.svg deleted file mode 100644 index da552de..0000000 --- a/fern/versions/v2.0/images/a7b65c5-LightMode.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/fern/versions/v2.0/images/acf7ea5-Overview.png b/fern/versions/v2.0/images/acf7ea5-Overview.png deleted file mode 100644 index daa0605..0000000 Binary files a/fern/versions/v2.0/images/acf7ea5-Overview.png and /dev/null differ diff --git a/fern/versions/v2.0/images/f0b81b5-FLOW-OF-FUNDS-APIS.png b/fern/versions/v2.0/images/f0b81b5-FLOW-OF-FUNDS-APIS.png deleted file mode 100644 index 18a2172..0000000 Binary files a/fern/versions/v2.0/images/f0b81b5-FLOW-OF-FUNDS-APIS.png and /dev/null differ diff --git a/fern/versions/v2.0/pages/api-backend/grant-statuses.mdx b/fern/versions/v2.0/pages/api-backend/grant-statuses.mdx deleted file mode 100644 index 1416ce1..0000000 --- a/fern/versions/v2.0/pages/api-backend/grant-statuses.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "Grant Statuses" -slug: "grant-statuses" -subtitle: "Overview of Chariot Grant Statuses" -hidden: false -createdAt: "Tue Dec 12 2023 21:57:00 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Thu Mar 28 2024 22:17:59 GMT+0000 (Coordinated Universal Time)" ---- -The following describes the available set of statuses for grants that are initiated through Chariot. There is no guarantee that every grant initiated through Chariot will reach a final, completed state as a confirmation may be required from the receiving nonprofit. - -# Grants - -| Status | Description | What's next | -| :---------- | :--------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Initiated` | The payment has been successfully received by the DAF provider. | The status will move to `Completed` state when the nonprofit receives the payment from the DAF provider. It will move to `Canceled` if the payment is never received by the nonprofit. | -| `Canceled` | The grant was canceled by the donor or the DAF provider did not approve the grant. | The nonprofit should let Chariot know that the payment did not arrive. No processing fees will be taken/charged. | -| `Completed` | The payment has been completed and the funds are in the nonprofit's bank. | | - diff --git a/fern/versions/v2.0/pages/api-backend/postman.mdx b/fern/versions/v2.0/pages/api-backend/postman.mdx deleted file mode 100644 index 2d55a93..0000000 --- a/fern/versions/v2.0/pages/api-backend/postman.mdx +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: "Postman" -slug: "postman" -subtitle: "" -hidden: false -createdAt: "Thu Feb 23 2023 03:07:32 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Tue Dec 12 2023 22:09:31 GMT+0000 (Coordinated Universal Time)" ---- -# Chariot API Postman - -## Fork the Collection - -If you normally use Postman for API development, you can fork the collection from [Chariot's Public Workspace](https://www.postman.com/givechariot/workspace/chariot-public-workspace/overview) to test out and develop against the Chariot APIs within Postman. - -[![Run in Postman](https://run.pstmn.io/button.svg)](https://app.getpostman.com/run-collection/23306205-95018796-5a2c-4332-99a0-472c1b32bae1?action=collection%2Ffork&collection-url=entityId%3D23306205-95018796-5a2c-4332-99a0-472c1b32bae1%26entityType%3Dcollection%26workspaceId%3Dc7217a87-0e57-45c0-8ead-53c23b4ec878#?env%5BSandbox%5D=W3sia2V5IjoiYmFzZVVybCIsInZhbHVlIjoiaHR0cHM6Ly9zYW5kYm94YXBpLmdpdmVjaGFyaW90LmNvbSIsImVuYWJsZWQiOnRydWUsInR5cGUiOiJkZWZhdWx0Iiwic2Vzc2lvblZhbHVlIjoiaHR0cHM6Ly9zYW5kYm94YXBpLmdpdmVjaGFyaW90LmNvbSIsInNlc3Npb25JbmRleCI6MH0seyJrZXkiOiJvYXV0aFRva2VuVXJsIiwidmFsdWUiOiJodHRwczovL2NoYXJpb3Qtc2FuZGJveC51cy5hdXRoMC5jb20vb2F1dGgvdG9rZW4iLCJlbmFibGVkIjp0cnVlLCJ0eXBlIjoiZGVmYXVsdCIsInNlc3Npb25WYWx1ZSI6Imh0dHBzOi8vY2hhcmlvdC1zYW5kYm94LnVzLmF1dGgwLmNvbS9vYXV0aC90b2tlbiIsInNlc3Npb25JbmRleCI6MX0seyJrZXkiOiJvYXV0aENsaWVudElkIiwidmFsdWUiOiIiLCJlbmFibGVkIjpmYWxzZSwidHlwZSI6ImRlZmF1bHQiLCJzZXNzaW9uVmFsdWUiOiIiLCJzZXNzaW9uSW5kZXgiOjJ9LHsia2V5Ijoib2F1dGhDbGllbnRTZWNyZXQiLCJ2YWx1ZSI6IiIsImVuYWJsZWQiOmZhbHNlLCJ0eXBlIjoic2VjcmV0Iiwic2Vzc2lvblZhbHVlIjoiIiwic2Vzc2lvbkluZGV4IjozfV0=) - -## Setup Environments - -- Sandbox - This is the testing environment that you should use in a pre-production environment while developing and testing the Chariot integration. -- Production - This is the production environment that you should use for real data and donations. - -## Setup Authorization - -To run requests you'll need to configure OAuth2 Authorization using your OAuth Client Credentials. - -You can setup OAuth authorization at the collection level and reuse the same OAuth token for all requests within the collection. The best practice is to leverage the Postman Environments provided to save and re-use environment-related variables such as the following to make it simple to setup OAuth: - -- `oauthTokenUrl` - the OAuth Token URL endpoint -- `oauthClientId` - the OAuth Client ID -- `oauthClientSecret` - the OAuth Client Secret - diff --git a/fern/versions/v2.0/pages/api-backend/webhooks-and-events.mdx b/fern/versions/v2.0/pages/api-backend/webhooks-and-events.mdx deleted file mode 100644 index 7564303..0000000 --- a/fern/versions/v2.0/pages/api-backend/webhooks-and-events.mdx +++ /dev/null @@ -1,120 +0,0 @@ ---- -title: "Webhooks and Events" -slug: "webhooks-and-events" -subtitle: "Listen for events on your Chariot account so your platform can automatically trigger reactions." -hidden: false -createdAt: "Tue Jan 23 2024 19:53:12 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Wed Apr 17 2024 17:28:24 GMT+0000 (Coordinated Universal Time)" ---- -When something interesting happens on the nonprofit's Chariot account, such as a Grant being created or its status being updated, Chariot can send a message to your application so that you can take action automatically. - -The first step is to create an Event Subscription via the [API](/api-reference/event-subscriptions/create). As part of this, you specify a URL for a server endpoint that will receive real-time events. Chariot will then send HTTPS requests to that URL to notify you of activity for certain events. - -When a noteworthy event happens, Chariot first generates an [Event](/api-reference/events/get). Next, we'll send a POST request to your endpoint. The body of the POST request will be the same as the API representation of the Event, such as: - -```json event.json -{ - "id": "event_123abc", - "created_at": "2023-01-31T23:59:59Z", - "category": "grant.created", - "associated_object_type": "grant", - "associated_object_id": "67d66b89-51a0-4f17-a7b3-18c5dbac5361" -} - -``` - -Note that you can create Event Subscriptions in Production and Sandbox. Sandbox Event Subscriptions will receive events for Sandbox events and vice versa. - -## Consuming Events - -Individual Events don’t contain very much information on their own. This is by design, as the API structure can remain extremely stable and avoid difficult webhook migrations in the future as the Chariot API changes. If you need additional metadata, such as the amount or status of the Grant in the above example, make a GET request to the API for that information. - -If you don't want to use webhooks, or need to do some batch processing, you can also request Events from the Chariot API using the [List Events API](/api-reference/events/list). Events will remain in the Chariot system for up to 30 days. - -### Event Types - -These events represent specific occurrences within our system that you can subscribe to and receive notifications for. - -- `grant.created`: This event is triggered when a grant is created. -- `grant.updated`: This event is triggered when a grant is updated. This can happen when the status changes for example. -- `unintegrated_grant.created`: This event is triggered when an unintegrated grant is created. -- `unintegrated_grant.updated`: This event is triggered when an unintegrated grant is updated. - -## Secure your webhooks - -After you've confirmed that your webhook endpoint connections works as expected, secure the connection by verifying the signature provided in the header of the webhook request. - - -In order to verify signatures for webhooks, you need to specify the signing secret that you will use in the [Create Event Subscription API](/api-reference/event-subscriptions/create). - - -Chariot will include the `Chariot-Webhook-Signature` header in each webhook request. This header will contain a timestamp and one or more signatures. The timestamp is prefixed by `t=`, and each signature is prefixed by a scheme. Schemes start with `v`, followed by an integer. Currently, the only valid live signature scheme is `v1`. - -``` -Chariot-Webhook-Signature: t=2024-01-19T18:48:56Z,v1=e0632fb61f7d1068ecbde75410d5c3cc152926f97eaacf53c6228624647329da -``` - -Chariot generates signatures using a hash-based message authentication code ([HMAC](https://en.wikipedia.org/wiki/HMAC)) with [SHA-256](https://en.wikipedia.org/wiki/SHA-2). To prevent [downgrade attacks](https://en.wikipedia.org/wiki/Downgrade_attack), ignore all schemes that are not v1. - -### Verify Signatures Manually - -#### Step 1: Extract the timestamp and signatures from the header - -Split the header using the `,` character as the separator to get a list of elements. Then split each element using the `=` character as the separator to get a prefix and value pair. - -The value for the prefix `t` corresponds to the timestamp, and `v1` corresponds to the signature. You can discard all other elements. - -#### Step 2: Prepare the signed payload - -The `signed_payload` string is created by concatenating: - -- The timestamp (as a string) -- The character `.` -- The actual JSON payload (that is, the request body) - -#### Step 3: Determine the expected signature - -Compute an HMAC with the SHA256 hash function. Use the Event Subscription's `signingSecret` as the key, and use the `signed_payload` string as the message. - -#### Step 4: Compare the Signatures - -Compare the signature (or signatures) in the header to the expected signature. For an equality match, compute the difference between the current timestamp and the received timestamp, then decide if the difference is within your tolerance. - -To protect against timing attacks, use a constant-time-string comparison to compare the expected signature to each of the received signatures. - -## Failures and Retries - -In production, if your application returns anything other than a 20x HTTP status code, we’ll retry it up to 10 times with exponentially increasing backoffs. In your webhook endpoint implementation, we recommend you place inbound Events into your application’s own queuing system for asynchronous event processing, and return a 200 response from your endpoint as quickly as possible. Because we can't guarantee we'll receive your 200 acknowledgement, your webhook implementation should gracefully handle receiving the same webhook multiple times. - -To avoid queueing issues, we will not retry failed webhooks in the sandbox. - - -If all attempts to a webhook endpoint fail, after 5 days the endpoint will be disabled and we will stop sending event messages to that endpoint. - - -## Best Practices - -Review these best practices to make sure your webhooks remain secure and function well with your integration. - -### Handle Duplicate Events - -Webhook endpoints might occasionally receive the same event more than once. You can guard against duplicated event receipts by making your event processing idempotent. - -### Only subscribe to event categories your integration requires - -Configure your webhook endpoints to receive only the types of events required by your integration. Listening for extra events (or all events) puts undue strain on your server and we don’t recommend it. - -You can [Update an Event Subscription](/api-reference/event-subscriptions/update) to change the event category for a webhook endpoint with the API. - -### Receive events with an HTTPS server - -If you use an HTTPS URL for your webhook endpoint, Chariot validates that the connection to your server is secure before sending your webhook data. For this to work, your server must be correctly configured to support HTTPS with a valid server certificate. The Production environment requires HTTPS URLs. - -### Quickly return a 2xx response - -Your endpoint must quickly return a successful status code (2xx) prior to any complex logic that could cause a timeout. - -### Verify webhook signatures - -See the section above on [verifying webhook signatures](/webhooks-and-events#secure-your-webhooks) - diff --git a/fern/versions/v2.0/pages/chariot-api/connects-1.mdx b/fern/versions/v2.0/pages/chariot-api/connects-1.mdx deleted file mode 100644 index 3d0ba27..0000000 --- a/fern/versions/v2.0/pages/chariot-api/connects-1.mdx +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: "Connects" -slug: "connects-1" -subtitle: "" -hidden: false -createdAt: "Fri Jan 26 2024 19:37:55 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Fri Jan 26 2024 19:37:55 GMT+0000 (Coordinated Universal Time)" ---- - diff --git a/fern/versions/v2.0/pages/chariot-api/connects-1/create-connect.mdx b/fern/versions/v2.0/pages/chariot-api/connects-1/create-connect.mdx deleted file mode 100644 index 6b49cff..0000000 --- a/fern/versions/v2.0/pages/chariot-api/connects-1/create-connect.mdx +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: "Create Connect" -slug: "create-connect" -subtitle: "Get or create a Connect object. Only one Connect object can be created per Nonprofit for a given Fundraising Application. If one already exists, this will return a 200 status with the existing object. The returned Connect can be used to integrate the client-side Chariot Connect component using the id property (CID) and also query for data generated from the Chariot Connect instance from the Chariot API using the apiKey property." -hidden: false -createdAt: "Fri Dec 16 2022 20:26:29 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Fri Jan 26 2024 19:37:55 GMT+0000 (Coordinated Universal Time)" ---- - diff --git a/fern/versions/v2.0/pages/chariot-api/connects-1/get-connect.mdx b/fern/versions/v2.0/pages/chariot-api/connects-1/get-connect.mdx deleted file mode 100644 index de69291..0000000 --- a/fern/versions/v2.0/pages/chariot-api/connects-1/get-connect.mdx +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: "Get Connect" -slug: "get-connect" -subtitle: "Get a Connect object with the unique identifier (CID)" -hidden: false -createdAt: "Mon Dec 19 2022 20:57:07 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Fri Jan 26 2024 19:37:55 GMT+0000 (Coordinated Universal Time)" ---- - diff --git a/fern/versions/v2.0/pages/chariot-api/dafs-1.mdx b/fern/versions/v2.0/pages/chariot-api/dafs-1.mdx deleted file mode 100644 index 6f53da0..0000000 --- a/fern/versions/v2.0/pages/chariot-api/dafs-1.mdx +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: "DAFs" -slug: "dafs-1" -subtitle: "" -hidden: false -createdAt: "Fri Jan 26 2024 19:37:55 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Fri Jan 26 2024 19:37:55 GMT+0000 (Coordinated Universal Time)" ---- - diff --git a/fern/versions/v2.0/pages/chariot-api/dafs-1/get-daf.mdx b/fern/versions/v2.0/pages/chariot-api/dafs-1/get-daf.mdx deleted file mode 100644 index f7a9ca8..0000000 --- a/fern/versions/v2.0/pages/chariot-api/dafs-1/get-daf.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "Get DAF object" -slug: "get-daf" -subtitle: "Get a DAF object by id.\nIf the DAF does not exist, returns a 404 status.\nIf the provided ID is not a v4 UUID according to RFC 4122, returns a 400 status." -hidden: false -createdAt: "Wed Feb 22 2023 15:44:30 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Fri Jan 26 2024 19:37:55 GMT+0000 (Coordinated Universal Time)" ---- -If the provided ID is not a v4 UUID according to RFC 4122, returns a 400 status. - -If the DAF does not exist, returns a 404 status. - diff --git a/fern/versions/v2.0/pages/chariot-api/dafs-1/list-dafs.mdx b/fern/versions/v2.0/pages/chariot-api/dafs-1/list-dafs.mdx deleted file mode 100644 index fc5e97c..0000000 --- a/fern/versions/v2.0/pages/chariot-api/dafs-1/list-dafs.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "List DAFs" -slug: "list-dafs" -subtitle: "List all DAF objects. This API allows for paginating over many results." -hidden: false -createdAt: "Wed Feb 22 2023 15:44:30 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Fri Jan 26 2024 19:37:55 GMT+0000 (Coordinated Universal Time)" ---- -Returns a list of the Donor Advised Fund providers that are supported through Chariot. - -This API allows for paginating over many results. - diff --git a/fern/versions/v2.0/pages/chariot-api/event-subscriptions.mdx b/fern/versions/v2.0/pages/chariot-api/event-subscriptions.mdx deleted file mode 100644 index 382655f..0000000 --- a/fern/versions/v2.0/pages/chariot-api/event-subscriptions.mdx +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: "Event Subscriptions" -slug: "event-subscriptions" -subtitle: "" -hidden: false -createdAt: "Fri Jan 26 2024 19:37:55 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Wed Apr 17 2024 17:28:37 GMT+0000 (Coordinated Universal Time)" ---- - diff --git a/fern/versions/v2.0/pages/chariot-api/event-subscriptions/createeventsubscription.mdx b/fern/versions/v2.0/pages/chariot-api/event-subscriptions/createeventsubscription.mdx deleted file mode 100644 index 1c2704e..0000000 --- a/fern/versions/v2.0/pages/chariot-api/event-subscriptions/createeventsubscription.mdx +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: "Create an Event Subscription" -slug: "createeventsubscription" -subtitle: "Create an event subscription corresponding to your Chariot account." -hidden: false -createdAt: "Tue Jan 23 2024 19:47:17 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Wed Apr 17 2024 17:28:37 GMT+0000 (Coordinated Universal Time)" ---- - diff --git a/fern/versions/v2.0/pages/chariot-api/event-subscriptions/geteventsubscription.mdx b/fern/versions/v2.0/pages/chariot-api/event-subscriptions/geteventsubscription.mdx deleted file mode 100644 index 55beeed..0000000 --- a/fern/versions/v2.0/pages/chariot-api/event-subscriptions/geteventsubscription.mdx +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: "Retrieve an Event Subscription" -slug: "geteventsubscription" -subtitle: "Retrieve an event subscription corresponding to your Chariot account." -hidden: false -createdAt: "Tue Jan 23 2024 19:47:17 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Wed Apr 17 2024 17:28:37 GMT+0000 (Coordinated Universal Time)" ---- - diff --git a/fern/versions/v2.0/pages/chariot-api/event-subscriptions/listeventsubscriptions.mdx b/fern/versions/v2.0/pages/chariot-api/event-subscriptions/listeventsubscriptions.mdx deleted file mode 100644 index 2913c4e..0000000 --- a/fern/versions/v2.0/pages/chariot-api/event-subscriptions/listeventsubscriptions.mdx +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: "List Event Subscriptions" -slug: "listeventsubscriptions" -subtitle: "List all event subscriptions corresponding to your Chariot account." -hidden: false -createdAt: "Tue Jan 23 2024 19:47:17 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Wed Apr 17 2024 17:28:37 GMT+0000 (Coordinated Universal Time)" ---- - diff --git a/fern/versions/v2.0/pages/chariot-api/event-subscriptions/updateeventsubscription.mdx b/fern/versions/v2.0/pages/chariot-api/event-subscriptions/updateeventsubscription.mdx deleted file mode 100644 index 7e0d2e9..0000000 --- a/fern/versions/v2.0/pages/chariot-api/event-subscriptions/updateeventsubscription.mdx +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: "Update an Event Subscription" -slug: "updateeventsubscription" -subtitle: "Update an event subscription corresponding to your Chariot account." -hidden: false -createdAt: "Tue Jan 23 2024 19:47:17 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Wed Apr 17 2024 17:28:37 GMT+0000 (Coordinated Universal Time)" ---- - diff --git a/fern/versions/v2.0/pages/chariot-api/events-1.mdx b/fern/versions/v2.0/pages/chariot-api/events-1.mdx deleted file mode 100644 index efd2264..0000000 --- a/fern/versions/v2.0/pages/chariot-api/events-1.mdx +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: "Events" -slug: "events-1" -subtitle: "" -hidden: false -createdAt: "Fri Jan 26 2024 19:37:55 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Wed Apr 17 2024 17:28:31 GMT+0000 (Coordinated Universal Time)" ---- - diff --git a/fern/versions/v2.0/pages/chariot-api/events-1/getevent.mdx b/fern/versions/v2.0/pages/chariot-api/events-1/getevent.mdx deleted file mode 100644 index 83e08fc..0000000 --- a/fern/versions/v2.0/pages/chariot-api/events-1/getevent.mdx +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: "Retrieve an Event" -slug: "getevent" -subtitle: "Retrieve an event corresponding to your Chariot account." -hidden: false -createdAt: "Tue Jan 23 2024 19:47:17 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Wed Apr 17 2024 17:28:31 GMT+0000 (Coordinated Universal Time)" ---- - diff --git a/fern/versions/v2.0/pages/chariot-api/events-1/listevents.mdx b/fern/versions/v2.0/pages/chariot-api/events-1/listevents.mdx deleted file mode 100644 index 04a52f1..0000000 --- a/fern/versions/v2.0/pages/chariot-api/events-1/listevents.mdx +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: "List Events" -slug: "listevents" -subtitle: "List all events corresponding to your Chariot account." -hidden: false -createdAt: "Tue Jan 23 2024 19:47:17 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Wed Apr 17 2024 17:28:31 GMT+0000 (Coordinated Universal Time)" ---- - diff --git a/fern/versions/v2.0/pages/chariot-api/grants-1.mdx b/fern/versions/v2.0/pages/chariot-api/grants-1.mdx deleted file mode 100644 index 1fa7734..0000000 --- a/fern/versions/v2.0/pages/chariot-api/grants-1.mdx +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: "Grants" -slug: "grants-1" -subtitle: "" -hidden: false -createdAt: "Fri Jan 26 2024 19:37:55 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Fri Jan 26 2024 19:37:55 GMT+0000 (Coordinated Universal Time)" ---- - diff --git a/fern/versions/v2.0/pages/chariot-api/grants-1/create-grant.mdx b/fern/versions/v2.0/pages/chariot-api/grants-1/create-grant.mdx deleted file mode 100644 index 86a7e6a..0000000 --- a/fern/versions/v2.0/pages/chariot-api/grants-1/create-grant.mdx +++ /dev/null @@ -1,16 +0,0 @@ ---- -title: "Create Grant" -slug: "create-grant" -subtitle: "Create a grant from a workflow session. This is useful to capture a grant intent from an authorized connect workflow session and submit the grant request.\nThe grant must be captured within 5 minutes of authorization otherwise the request will return status 410 Gone.\nA grant can only be captured once from any given workflow session so any duplicate requests will return status 409 Conflict.\nThe grant amount must be in whole dollar increments (rounded to the nearest hundred) as currently DAFs only accept whole dollar grants.\nThe grant amount must be greater than or equal to the minimum grant amount for the DAF otherwise the request will return status 400 Bad Request.\nThe grant amount must be less than or equal to the user's DAF account balance otherwise the request will return status 400 Bad Request." -hidden: false -createdAt: "Fri Nov 11 2022 21:12:48 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Fri Jan 26 2024 19:37:55 GMT+0000 (Coordinated Universal Time)" ---- -This is useful to capture a grant intent from an authorized Connect workflow session and submit the grant request. A grant can only be captured once from any given workflow session so any duplicate requests will return status 409 Conflict. - -The grant amount must be in whole dollar increments (rounded to the nearest hundred) as currently DAFs only accept whole dollar grants. The grant 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 grant amount must be less than or equal to the user's DAF account balance otherwise the request will return status 400 Bad Request. - - -Generally grants should be captured as soon as possible after a grant intent is authorized by a user to optimize for conversion. We recommend a soft limit of 5 minutes and enforce a hard limit of 15 minutes. This means that after 5 minutes, there's a higher chance of an error and after 15 minutes, the request will return status 410 Gone. - - diff --git a/fern/versions/v2.0/pages/chariot-api/grants-1/get-grant.mdx b/fern/versions/v2.0/pages/chariot-api/grants-1/get-grant.mdx deleted file mode 100644 index d2b7188..0000000 --- a/fern/versions/v2.0/pages/chariot-api/grants-1/get-grant.mdx +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: "Get Grant" -slug: "get-grant" -subtitle: "Get a grant object generated by Chariot Connect.\nIf the grant does not exist, returns a 404 status.\nIf the provided ID is not a v4 UUID according to RFC 4122, returns a 400 status." -hidden: false -createdAt: "Sun Oct 16 2022 15:25:23 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Fri Jan 26 2024 19:37:55 GMT+0000 (Coordinated Universal Time)" ---- - diff --git a/fern/versions/v2.0/pages/chariot-api/grants-1/get-unintegrated-grant.mdx b/fern/versions/v2.0/pages/chariot-api/grants-1/get-unintegrated-grant.mdx deleted file mode 100644 index 68c2a7f..0000000 --- a/fern/versions/v2.0/pages/chariot-api/grants-1/get-unintegrated-grant.mdx +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: "Get Unintegrated Grant" -slug: "get-unintegrated-grant" -subtitle: "Get an unintegrated grant object generated by Chariot Connect.\nIf the grant does not exist, returns a 404 status.\nIf the provided ID is not a v4 UUID according to RFC 4122, returns a 400 status." -hidden: false -createdAt: "Tue Jan 30 2024 22:38:20 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Tue Jan 30 2024 22:38:20 GMT+0000 (Coordinated Universal Time)" ---- - diff --git a/fern/versions/v2.0/pages/chariot-api/grants-1/list-grants.mdx b/fern/versions/v2.0/pages/chariot-api/grants-1/list-grants.mdx deleted file mode 100644 index fb32efe..0000000 --- a/fern/versions/v2.0/pages/chariot-api/grants-1/list-grants.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "List Grants" -slug: "list-grants" -subtitle: "List all grants for the provided API Key. This API allows for paginating over many results." -hidden: false -createdAt: "Fri Nov 11 2022 21:12:48 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Fri Jan 26 2024 19:37:55 GMT+0000 (Coordinated Universal Time)" ---- -Returns a list of Grants that were created from an instance of [Connect](/api-reference/connects/get). The `apiKey` from the Connect object should be passed in the `x-chariot-api-key` header for this request. - -This API allows for paginating over many results. - diff --git a/fern/versions/v2.0/pages/chariot-api/grants-1/list-unintegrated-grants.mdx b/fern/versions/v2.0/pages/chariot-api/grants-1/list-unintegrated-grants.mdx deleted file mode 100644 index 1f0a374..0000000 --- a/fern/versions/v2.0/pages/chariot-api/grants-1/list-unintegrated-grants.mdx +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: "List Unintegrated Grants" -slug: "list-unintegrated-grants" -subtitle: "List all unintegrated grants for the provided API Key. This API allows for paginating over many results." -hidden: false -createdAt: "Tue Jan 30 2024 22:38:20 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Tue Jan 30 2024 22:38:20 GMT+0000 (Coordinated Universal Time)" ---- - diff --git a/fern/versions/v2.0/pages/chariot-api/grants-1/update-grant.mdx b/fern/versions/v2.0/pages/chariot-api/grants-1/update-grant.mdx deleted file mode 100644 index fae0626..0000000 --- a/fern/versions/v2.0/pages/chariot-api/grants-1/update-grant.mdx +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: "Update Grant" -slug: "update-grant" -subtitle: "Update a grant object generated by Chariot Connect.\nThis is useful to update the status or acknowledgement of the grant.\nIf the grant does not exist, returns a 404 status.\nIf the provided ID is not a v4 UUID according to RFC 4122, returns a 400 status." -hidden: false -createdAt: "Tue Jan 30 2024 22:38:20 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Tue Jan 30 2024 22:38:20 GMT+0000 (Coordinated Universal Time)" ---- - diff --git a/fern/versions/v2.0/pages/chariot-api/grants-1/update-unintegrated-grant.mdx b/fern/versions/v2.0/pages/chariot-api/grants-1/update-unintegrated-grant.mdx deleted file mode 100644 index 48cc3a5..0000000 --- a/fern/versions/v2.0/pages/chariot-api/grants-1/update-unintegrated-grant.mdx +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: "Update Unintegrated Grant" -slug: "update-unintegrated-grant" -subtitle: "Update an unintegrated grant object generated by Chariot Connect.\nThis is useful to update the status or acknowledgement of the unintegrated grant.\nIf the unintegrated grant does not exist, returns a 404 status.\nIf the provided ID is not a v4 UUID according to RFC 4122, returns a 400 status." -hidden: false -createdAt: "Tue Jan 30 2024 22:38:20 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Tue Jan 30 2024 22:38:20 GMT+0000 (Coordinated Universal Time)" ---- - diff --git a/fern/versions/v2.0/pages/chariot-api/nonprofits-1.mdx b/fern/versions/v2.0/pages/chariot-api/nonprofits-1.mdx deleted file mode 100644 index 83fe520..0000000 --- a/fern/versions/v2.0/pages/chariot-api/nonprofits-1.mdx +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: "Nonprofits" -slug: "nonprofits-1" -subtitle: "" -hidden: false -createdAt: "Fri Jan 26 2024 19:37:55 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Fri Jan 26 2024 19:37:55 GMT+0000 (Coordinated Universal Time)" ---- - diff --git a/fern/versions/v2.0/pages/chariot-api/nonprofits-1/create-nonprofit.mdx b/fern/versions/v2.0/pages/chariot-api/nonprofits-1/create-nonprofit.mdx deleted file mode 100644 index e2f9609..0000000 --- a/fern/versions/v2.0/pages/chariot-api/nonprofits-1/create-nonprofit.mdx +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: "Create nonprofit" -slug: "create-nonprofit" -subtitle: "Create a nonprofit organization account.\nThis is useful for integration partners to use after a nonprofit consents to use the Chariot payment option on their donation forms.\nIf a nonprofit does not already exist for the EIN, this will return a 201 Created status.\nIf a nonprofit already exists for the given EIN on the system, this will return a 200 Created status.\nIf the nonprofit does not pass our compliance checks, a 422 Unprocessable Content is returned with a reason." -hidden: false -createdAt: "Fri Dec 16 2022 20:26:29 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Fri Jan 26 2024 19:37:55 GMT+0000 (Coordinated Universal Time)" ---- - diff --git a/fern/versions/v2.0/pages/chariot-api/nonprofits-1/get-nonprofit-by-ein.mdx b/fern/versions/v2.0/pages/chariot-api/nonprofits-1/get-nonprofit-by-ein.mdx deleted file mode 100644 index b7d2e4a..0000000 --- a/fern/versions/v2.0/pages/chariot-api/nonprofits-1/get-nonprofit-by-ein.mdx +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: "Get nonprofit by EIN" -slug: "get-nonprofit-by-ein" -subtitle: "Get a nonprofit organization by EIN.\nIf the nonprofit does not exist, this returns 404 Not Found status.\nIf the nonprofit does not pass our compliance checks, a 422 Unprocessable Content is returned with a reason.\nIn the case that the nonprofit does not exist, you can create one by calling the POST /v1/nonprofits API endpoint.\nThe EIN should be exactly 9 digits and should not contain any special characters such as dashes." -hidden: true -createdAt: "Fri Dec 16 2022 20:26:29 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Fri Mar 29 2024 17:20:54 GMT+0000 (Coordinated Universal Time)" ---- - diff --git a/fern/versions/v2.0/pages/chariot-api/nonprofits-1/get-nonprofit-by-id.mdx b/fern/versions/v2.0/pages/chariot-api/nonprofits-1/get-nonprofit-by-id.mdx deleted file mode 100644 index 239a34e..0000000 --- a/fern/versions/v2.0/pages/chariot-api/nonprofits-1/get-nonprofit-by-id.mdx +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: "Get nonprofit by ID" -slug: "get-nonprofit-by-id" -subtitle: "Get a nonprofit organization by ID.\nIf the nonprofit does not exist, this returns 404 Not Found status." -hidden: false -createdAt: "Mon Mar 25 2024 21:56:32 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Mon Mar 25 2024 21:56:32 GMT+0000 (Coordinated Universal Time)" ---- - diff --git a/fern/versions/v2.0/pages/chariot-connect/chariot-connect-overview.mdx b/fern/versions/v2.0/pages/chariot-connect/chariot-connect-overview.mdx deleted file mode 100644 index b0625d7..0000000 --- a/fern/versions/v2.0/pages/chariot-connect/chariot-connect-overview.mdx +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: "Overview" -slug: "chariot-connect-overview" -subtitle: "Use Chariot Connect to allow users to initiate grant requests from their Donor Advised Funds" -hidden: false -metadata: - image: [] - robots: "index" -createdAt: "Tue May 31 2022 18:36:21 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Thu Jun 02 2022 19:16:01 GMT+0000 (Coordinated Universal Time)" ---- -# Chariot Connect - -![](../../images/9339d40-Connect-no-words.png "Connect-no-words.png") -## Introduction - -Chariot Connect is the client-side component that your users will interact with in order to initiate grant recommendations from their Donor Advised Funds. - -Chariot Connect will handle credential validation, multi-factor authentication, and error handling for each Donor Advised Fund that we support. Connect works across all modern browsers and platforms. - -## Initialization - -Chariot Connect is initialized by passing a **connect_token** to Connect's configuration. This token is generated by calling the [/connect/token/retreive](/api-reference/connects/get_token) endpoint. Additionally, onSuccess and onExit callback functions can be set to handle successful and unsuccessful donation attempts. For more information, see [Integrating Connect](doc:connect-for-web). - -## Connect flow overview - -The diagram below shows a model of how Chariot Connect is initialized using a connect_token. It then shows how to retrieve the data the button generated by calling the Connect API. -
- -![](../../images/acf7ea5-Overview.png "Overview.png") diff --git a/fern/versions/v2.0/pages/chariot-connect/connect-for-web.mdx b/fern/versions/v2.0/pages/chariot-connect/connect-for-web.mdx deleted file mode 100644 index b3c02b2..0000000 --- a/fern/versions/v2.0/pages/chariot-connect/connect-for-web.mdx +++ /dev/null @@ -1,143 +0,0 @@ ---- -title: "Integrating Connect" -slug: "connect-for-web" -subtitle: "Reference for initializing Chariot Connect using Chariot JavaScript SDK" -hidden: false -metadata: - image: [] - robots: "index" -createdAt: "Tue May 31 2022 18:52:52 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Thu Jun 02 2022 19:03:29 GMT+0000 (Coordinated Universal Time)" ---- -Include the Chariot Connect initialize script on each page of your site. It must always be loaded directly from [https://cdn.givechariot.com](https://cdn.givechariot.com), rather than included in a bundle or hosted yourself - -```javascript index.html - -``` - -## Create - -Chariot.create accepts one argument, a configuration Object, and returns an Object with three functions, open, exit, and destroy. Calling open will display the Consent Pane view, calling exit will close Connect, and calling destroy will clean up the iframe. - -```javascript Create Example -const handler = Chariot.create({ - connect_token: 'GENERATED_CONNECT_TOKEN', - onSuccess: (metadata) => {}, - onExit: (err, metadata) => {} -}); -``` - -| Parameter | Description | Type | -| :---------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | :------- | -| **connect_token** | Specify a connect_token which allows Connect to know which nonprofit the funds are being sent to and add the nonprofit's customized wording to the Connect flow. This token does not expire but the nonprofit can revoke it. Receive this token by calling the [Get Connect Token](/api-reference/connects/get_token) endpoint. | string | -| **onSuccess** | A function that is called when a user successfully completes a grant request through Connect. The function should expect one argument, a metadata object. | callback | -| **onExit** | A function that is called when a user exits Connect without successfully initiating a grant request, or when an error occurs during Connect initialization. The function should expect two arguments, a nullable error object and a metadata object. | callback | - -## onSuccess - -The onSuccess callback is called when a user successfully initiates a grant request. It takes one argument: a metadata object. - -```javascript onSuccess example -const handler = Chariot.create({ - ..., - onSuccess: (metadata) => { - fetch('//yourserver.com/metadata', { - method: 'POST', - body: { - //Save whatever info you may want from the metadata - }, - }); - } -}); -``` - -```json Metadata schema -{ - institution:{ - name:"Fidelity Charitable", - institution_id:"ins_4" - }, - grant: { - id:"ygPnJweommTWNr9doD6ZfGR6GGVQy7fyREmWy", - amount:{ - amount:2000, - amountString:"$20" - }, - status : "RECEIVED", - organizationId:"064ccc97-fc4d-489a-8487-5b4731786d39", - contactInformationFields:{ - name: "John Smith", - email: "johnsmith@gmail.com", - phone: "000-000-0000" - }, - designation:"where_needed_most", - frequency:"once", - personalNote:"This is my first donation through CharityVest!" - }, - connect_session_id:"79e772be-547d-4c9c-8b76-4ac4ed4c441a" -} -``` - -| Parameter | Description | Type | -| :--------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :---------------- | -| **institution.name** | A readable format of the Donor Advised Fund institution that received this donation request | string | -| **institution.institution_id** | A unique identifier for the Donor Advised Fund institution | string | -| **grant.id** | A unique identifier for this grant | string | -| **grant.amount** | The amount requested to be donated | object | -| **grant.status** | The status of the grant. Learn more in [Webhooks](/api-reference/webhooks) | string (enum) | -| **grant.organizationId** | a unique identifier for the nonprofit organization receiving the donation | string | -| **grant.contactInformationFields** | contact information the donor has approved to share | object | -| **grant.designation** | the specific fund the donor wants to send the money to | string (optional) | -| **grant.frequency** | the frequency for the donation. The options for this field are set by the nonprofit | string | -| **grant.personalNote** | a free form note the donor included in the donation | string (optional) | -| **connect_session_id** | a unique identifier associated with a user's actions and events through the Connect flow. Include this identifier when opening a support ticket for faster turnaround. | string | - -## OnExit - -The onExit callback is called when a user exits Connect without successfully initiating a grant request, or when an error occurs during Connect initialization. It takes two arguments, a nullable error object and a metadata object. The metadata parameter is always present, though some values may be null. - -```javascript onExit example -const handler = Chariot.create({ - ..., - onExit: (error, metadata) => { - // Save data from the onExit handler - supportHandler.report({ - error: error, - institution: metadata.institution, - connect_session_id: metadata.connect_session_id, - chariot_request_id: metadata.request_id, - status: metadata.status, - }); - }, -}); -``` - -```javascript Errror schema -{ - error_type: 'ITEM_ERROR', - error_code: 'INVALID_CREDENTIALS', - error_message: 'the credentials were not correct', - display_message: 'The credentials were not correct.', -} -``` - -```json Metadata schema -{ - institution: { - name: 'Fidelity Charitable', - institution_id: 'ins_4' - }, - status: 'requires_credentials', - chariot_session_id: '36e201e0-2280-46f0-a6ee-6d417b450438', - request_id: '8C7jNbDScC24THu' -} -``` - -| Parameter | Description | Type | -| :---------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :----- | -| **institution.name** | The full institution name, such as "Fidelity Charitable" | string | -| **institution.id** | The Chariot Donor Advised Fund identifier | string | -| **status** | The point at which the user exited the Connect flow. One of the following values | string | -| **chariot_session_id** | A unique identifier associated with a user's actions and events through the Connect flow. Include this identifier when opening a support ticket for faster turnaround. | string | -| **request_id** | The request ID for the last request made by Connect. This can be shared with Chariot Support to expedite investigation. | string | - diff --git a/fern/versions/v2.0/pages/chariot-connect/error-handling.mdx b/fern/versions/v2.0/pages/chariot-connect/error-handling.mdx deleted file mode 100644 index 9d772c3..0000000 --- a/fern/versions/v2.0/pages/chariot-connect/error-handling.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: "Error Handling" -slug: "error-handling" -subtitle: "" -hidden: false -metadata: - image: [] - robots: "index" -createdAt: "Tue May 31 2022 19:09:56 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Thu Jun 02 2022 19:08:44 GMT+0000 (Coordinated Universal Time)" ---- -### Missing institution or "Connectivity not supported" error - -If your user has a Donor-Advised Fund that Chariot does not currently integrate with, then Connect will allow the user to select that DAF and give detailed instructions on how to complete their DAF donation. Connect will hyperlink the user to their DAF login portal and allow the donor to notify Chariot that the donation was placed. - -[Insert image showing modules] - -### Institution status in Connect - -Connect proactively lets users know if an institution's connection isn't performing well. Below are the three views a user will see depending on the status of the institution they select. - -When the status of an institution is DEGRADED, Connect will warn users that they may experience issues and allow them to continue. Once the status becomes DOWN, Connect will block users from attempting to log in and suggest the "Missing Institution" flow described above - -![](../../images/41e910d-Group_549.png "Group 549.png") diff --git a/fern/versions/v2.0/pages/connect-frontend/error-handling-1.mdx b/fern/versions/v2.0/pages/connect-frontend/error-handling-1.mdx deleted file mode 100644 index 83319d8..0000000 --- a/fern/versions/v2.0/pages/connect-frontend/error-handling-1.mdx +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: "Error Handling & Edge Cases" -slug: "error-handling-1" -subtitle: "" -hidden: false -createdAt: "Thu Jun 02 2022 19:47:50 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Wed May 01 2024 21:32:32 GMT+0000 (Coordinated Universal Time)" ---- -### Minimum donation requirement and insufficient account balances - -If a donor tries to submit a grant request for an amount that exceeds their current account balance, Connect will alert the donor and suggest the donor to adjust the donation amount to the available account balance. Additionally, if a Donor Advised Fund platform has a minimum donation requirement, Connect will alert donors of this requirement and suggest the donor to alter the donation size to match the minimum threshold for submission. - - - diff --git a/fern/versions/v2.0/pages/getting-started/navigating-the-docs.mdx b/fern/versions/v2.0/pages/getting-started/navigating-the-docs.mdx deleted file mode 100644 index a22575b..0000000 --- a/fern/versions/v2.0/pages/getting-started/navigating-the-docs.mdx +++ /dev/null @@ -1,13 +0,0 @@ ---- -title: "Navigating the Docs" -slug: "navigating-the-docs" -subtitle: "" -hidden: false -createdAt: "Sun May 21 2023 20:37:56 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Wed Jan 31 2024 01:46:58 GMT+0000 (Coordinated Universal Time)" ---- -The Chariot documentation is broken up into two main parts: - -1. [Chariot Connect](integrating-connect): The frontend, client-side component that launches [DAFPay](https://www.dafpay.com/): the application that users interact with in order to initiate grant requests from their Donor Advised Funds. Both React and Javascript SDKs are available. -2. [Chariot API](overview): The backend endpoints needed to register new nonprofits, submit grants, and query for transactional data and events. All endpoints much be authenticated using OAuth 2.0 Client Credentials Flow. - diff --git a/fern/versions/v2.0/pages/rest-api/api-reference-1.mdx b/fern/versions/v2.0/pages/rest-api/api-reference-1.mdx deleted file mode 100644 index 5e6e5c5..0000000 --- a/fern/versions/v2.0/pages/rest-api/api-reference-1.mdx +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: "API Reference" -slug: "api-reference-1" -subtitle: "" -hidden: false -metadata: - image: [] - robots: "index" -createdAt: "Thu Jun 02 2022 00:03:16 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Thu Jun 02 2022 00:03:19 GMT+0000 (Coordinated Universal Time)" -type: "link" -link_url: "https://givechariot.readme.io/reference/overview" ---- -