Cancel a pending disbursement

POST

/v1/disbursements/:id/cancel

POST

/v1/disbursements/:id/cancel

1 curl -X POST https://api.givechariot.com/v1/disbursements/disbursement_01jpjen1s23s29kkmnjsb6fzga/cancel \
2      -H "Authorization: Bearer <token>"

Try it

1 {
2   "id": "disbursement_01jpjen1s23s29kkmnjsb6fzga",
3   "organization_id": "org_01jpjenf5q6cawy43yxfcrxhct",
4   "amount": 10000,
5   "organization": {
6     "id": "org_01j8rs605a4gctmbm58d87mvsj",
7     "ein": "123456789",
8     "name": "American Red Cross",
9     "parent_organization_id": "org_01j8rs605a4gctmbm58d87mvsk",
10     "physical_address": {
11       "city": "city",
12       "country": "country",
13       "line1": "line1",
14       "postal_code": "postal_code",
15       "state": "state",
16       "line2": "line2"
17     },
18     "classification": {
19       "group_exemption_number": "group_exemption_number",
20       "subsection_code": {
21         "code": 1,
22         "name": "UNCONDITIONAL",
23         "description": "Unconditional Exemption"
24       },
25       "filing_requirement_code": {
26         "code": 1,
27         "name": "UNCONDITIONAL",
28         "description": "Unconditional Exemption"
29       },
30       "foundation_code": {
31         "code": 1,
32         "name": "UNCONDITIONAL",
33         "description": "Unconditional Exemption"
34       },
35       "affiliation_code": {
36         "code": 1,
37         "name": "UNCONDITIONAL",
38         "description": "Unconditional Exemption"
39       },
40       "organization_code": {
41         "code": 1,
42         "name": "UNCONDITIONAL",
43         "description": "Unconditional Exemption"
44       },
45       "exempt_status_code": {
46         "code": 1,
47         "name": "UNCONDITIONAL",
48         "description": "Unconditional Exemption"
49       },
50       "deductibility_code": {
51         "code": 1,
52         "name": "UNCONDITIONAL",
53         "description": "Unconditional Exemption"
54       },
55       "ntee_code": {
56         "code": "A",
57         "description": "Animal Welfare",
58         "parent_code": "A",
59         "parent_description": "Animal Welfare"
60       },
61       "naics_code": {
62         "naics2": "31",
63         "naics2_description": "Manufacturing",
64         "naics4": "3112",
65         "naics4_description": "Grain and Oilseed Milling",
66         "naics6": "311221",
67         "naics6_description": "Wet Corn Milling and Starch Manufacturing"
68       }
69     },
70     "compliance": {
71       "daf_eligible": true,
72       "irs_pub_78": {
73         "compliant": true,
74         "last_found_at": "2020-01-31T23:00:00Z"
75       },
76       "ofac": {
77         "compliant": true,
78         "last_found_at": "2020-01-31T23:00:00Z"
79       },
80       "foundation_code": {
81         "compliant": true,
82         "last_found_at": "2020-01-31T23:00:00Z"
83       },
84       "california_attorney_general_registry": {
85         "compliant": true,
86         "last_found_at": "2020-01-31T23:00:00Z"
87       },
88       "california_franchise_tax_board": {
89         "compliant": true,
90         "last_found_at": "2020-01-31T23:00:00Z"
91       }
92     },
93     "mission_statement": "To provide relief to those in need",
94     "web": {
95       "domain": "redcross.org"
96     },
97     "brand": {
98       "icon_url": "icon_url",
99       "logo_url": "logo_url"
100     },
101     "officers": [
102       {
103         "name": "name",
104         "title": "Executive Director",
105         "email": "johndoe@example.com",
106         "created_at": "2020-01-31T23:00:00Z",
107         "updated_at": "2020-01-31T23:59:59Z"
108       }
109     ],
110     "claimed": true
111   },
112   "description": "Disbursement to nonprofit",
113   "created_at": "2020-01-31T23:00:00Z",
114   "updated_at": "2020-01-31T23:00:00Z",
115   "status": "pending_approval",
116   "cancelation": {
117     "canceled_by": "user@example.com",
118     "canceled_at": "2020-01-31T23:00:00Z"
119   },
120   "approval": {
121     "approved_by": "user@example.com",
122     "approved_at": "2020-01-31T23:00:00Z"
123   },
124   "rejection": {
125     "reason": "insufficient_funds",
126     "rejected_at": "2020-01-31T23:00:00Z"
127   },
128   "transfers": [
129     {
130       "account_transfer": {
131         "id": "account_transfer_01j8rs605a4gctmbm58d87mvsj",
132         "amount": 10000,
133         "created_at": "2020-01-31T23:00:00Z"
134       },
135       "ach_transfer": {
136         "id": "ach_transfer_01j8rs605a4gctmbm58d87mvsj",
137         "amount": 10000,
138         "status": "initiated",
139         "created_at": "2020-01-31T23:00:00Z",
140         "company_entry_description": "Disbursement to nonprofit",
141         "trace_number": "012345678901234",
142         "effective_date": "2020-01-31T23:00:00Z",
143         "submitted_at": "2020-01-31T23:00:00Z",
144         "settled_at": "2020-07-12T15:00:00Z",
145         "rejected_at": "2020-07-12T15:00:00Z",
146         "returned_at": "2020-07-12T15:00:00Z",
147         "updated_at": "2020-01-31T23:00:00Z"
148       },
149       "check_transfer": {
150         "id": "check_transfer_01j8rs605a4gctmbm58d87mvsj",
151         "amount": 10000,
152         "status": "pending",
153         "memo": "Disbursement to nonprofit",
154         "mailing_address": {
155           "city": "city",
156           "country": "country",
157           "line1": "line1",
158           "postal_code": "postal_code",
159           "state": "state"
160         },
161         "created_at": "2020-01-31T23:00:00Z",
162         "check_number": "123456789",
163         "recipient_name": "Charity Good",
164         "tracking_updates": [
165           {
166             "category": "in_transit",
167             "created_at": "2020-01-31T23:00:00Z"
168           }
169         ],
170         "submitted_at": "2020-01-31T23:00:00Z",
171         "canceled_at": "2020-01-31T23:00:00Z",
172         "stopped_at": "2020-01-31T23:00:00Z",
173         "deposited_at": "2020-01-31T23:00:00Z",
174         "updated_at": "2020-01-31T23:00:00Z"
175       }
176     }
177   ],
178   "transactions": [
179     {
180       "amount": 10000,
181       "type": "donor_advised_fund_grant",
182       "id": "txn_1LaXpKGUcADgqoEMl0Cx0Ygg",
183       "description": "Disbursement to nonprofit",
184       "donor_advised_fund_grant": {
185         "grant_id": "grant_1234567890",
186         "organization_name": "Vanguard Charitable",
187         "fund_name": "John Doe Fund",
188         "purpose": "General Operating Support",
189         "note": "This grant is for the general operating support of the organization."
190       },
191       "created_at": "2020-01-31T23:00:00Z",
192       "updated_at": "2020-01-31T23:00:00Z",
193       "metadata": {
194         "key": "value"
195       }
196     }
197   ]
198 }

Cancel a pending disbursement in a pending_approval state. If the disbursement is in a different state, this will return a 400 error.

Path parameters

idstringRequired

The unique identifier for the disbursement

Response

The disbursement was canceled

idstring

The unique identifier for the disbursement

organization_idstring

The unique identifier for the organization that will receive the payment

amountlong

The payment amount in USD cents. Must be a positive amount.

organizationobject or null

An Organization represents an operating nonprofit or an operating sub-organization of a parent or sponsoring nonprofit. The generally accepted identifier for an organization is its domain. This domain provides proof of identity, ownership and relationship to an entity. Organizations can receive payments from payers on the network.

descriptionstring or null

A description of the disbursement that will be displayed to the receiving organization.

created_atdatetime or null

The date and time the disbursement was created

updated_atdatetime or null

The date and time the disbursement was last updated

statusenum or null

The lifecycle status of the disbursement. Possible values include:

pending_approval: The disbursement is awaiting approval from the grantmaker
canceled: The disbursement was canceled by the grantmaker
awaiting_verification: The disbursement is awaiting verification from Chariot
rejected: The disbursement was rejected by Chariot before being submitted
validating_organization: Validating recipient organization’s payment and contact information before submission.
pending_submission: The disbursement is awaiting submission to the payment network
submitted: The disbursement payment has been submitted to the payment network and is being processed
stopped: The disbursement payment was stopped after it was submitted
completed: The disbursement payment has been completed and funds have been received by the receiving organization
failed: The disbursement payment failed or the receiving organization did not receive the payment

To see a description of each status, see the “Disbursement Lifecycle” section of the Chariot documentation.

cancelationobject or null

If your account requires approvals for disbursements and the disbursement was not approved, this will contain the details of the cancelation.

approvalobject or null

If your account requires approvals for disbursements and the disbursement was approved, this will contain the details of the approval.

rejectionobject or null

If the disbursement was rejected by Chariot, this will contain details as to why the disbursement was rejected.

transferslist of objects or null

The list of transfers for the disbursement. This can have multiple items if the disbursement's underlying payment was retried multiple times. For example, if a check was returned or stopped and the disbursement was retried as an ACH transfer. If the disbursement was not retried, this will have a single item.

transactionslist of objects or null

The list of transactions for the disbursement

Cancel a pending disbursement

Path parameters

Headers

Response

Errors