disbursements
Cancel a pending disbursement
Cancel a pending disbursement in a pending_approval state. If the disbursement is in a different state, this will return a 400 error.
post/v1/disbursements/{id}/cancel
Path parameters
idstring required
The unique identifier for the disbursement
Response
The disbursement was canceled
Example response
{
"id": "disbursement_01jpjen1s23s29kkmnjsb6fzga",
"organization_id": "org_01jpjenf5q6cawy43yxfcrxhct",
"organization": {
"id": "org_01j8rs605a4gctmbm58d87mvsj",
"ein": "123456789",
"name": "American Red Cross",
"parent_organization_id": "org_01j8rs605a4gctmbm58d87mvsk",
"classification": {
"subsection_code": {
"code": 1,
"name": "UNCONDITIONAL",
"description": "Unconditional Exemption"
},
"filing_requirement_code": {
"code": 1,
"name": "UNCONDITIONAL",
"description": "Unconditional Exemption"
},
"foundation_code": {
"code": 1,
"name": "UNCONDITIONAL",
"description": "Unconditional Exemption"
},
"affiliation_code": {
"code": 1,
"name": "UNCONDITIONAL",
"description": "Unconditional Exemption"
},
"organization_code": {
"code": 1,
"name": "UNCONDITIONAL",
"description": "Unconditional Exemption"
},
"exempt_status_code": {
"code": 1,
"name": "UNCONDITIONAL",
"description": "Unconditional Exemption"
},
"deductibility_code": {
"code": 1,
"name": "UNCONDITIONAL",
"description": "Unconditional Exemption"
},
"ntee_code": {
"code": "A",
"description": "Animal Welfare",
"parent_code": "A",
"parent_description": "Animal Welfare"
},
"naics_code": {
"naics2": "31",
"naics2_description": "Manufacturing",
"naics4": "3112",
"naics4_description": "Grain and Oilseed Milling",
"naics6": "311221",
"naics6_description": "Wet Corn Milling and Starch Manufacturing"
}
},
"compliance": {
"daf_eligible": true,
"irs_pub_78": {
"compliant": true,
"last_found_at": "2020-01-31T23:00:00Z"
},
"ofac": {
"compliant": true,
"last_found_at": "2020-01-31T23:00:00Z"
},
"foundation_code": {
"compliant": true,
"last_found_at": "2020-01-31T23:00:00Z"
},
"california_attorney_general_registry": {
"compliant": true,
"last_found_at": "2020-01-31T23:00:00Z"
},
"california_franchise_tax_board": {
"compliant": true,
"last_found_at": "2020-01-31T23:00:00Z"
}
},
"mission_statement": "To provide relief to those in need",
"web": {
"domain": "redcross.org"
},
"officers": [
{
"title": "Executive Director"
}
]
},
"program_id": "program_01jpjenf5q6cawy43yxfcrxhct",
"amount": 10000,
"created_at": "2020-01-31T23:00:00Z",
"updated_at": "2020-01-31T23:00:00Z",
"status": "pending_approval",
"cancelation": {
"canceled_by": "user@example.com",
"canceled_at": "2020-01-31T23:00:00Z"
},
"approval": {
"approved_by": "user@example.com",
"approved_at": "2020-01-31T23:00:00Z"
},
"rejection": {
"reason": "insufficient_funds",
"rejected_at": "2020-01-31T23:00:00Z"
},
"transfers": [
{
"account_transfer": {
"id": "account_transfer_01j8rs605a4gctmbm58d87mvsj",
"amount": 10000,
"created_at": "2020-01-31T23:00:00Z"
},
"ach_transfer": {
"id": "ach_transfer_01j8rs605a4gctmbm58d87mvsj",
"amount": 10000,
"status": "initiated",
"company_entry_description": "Disbursement to nonprofit",
"trace_number": "012345678901234",
"effective_date": "2020-01-31T23:00:00Z",
"submitted_at": "2020-01-31T23:00:00Z",
"settled_at": "2020-07-12 15:00:00.000",
"rejected_at": "2020-07-12 15:00:00.000",
"returned_at": "2020-07-12 15:00:00.000",
"created_at": "2020-01-31T23:00:00Z",
"updated_at": "2020-01-31T23:00:00Z"
},
"check_transfer": {
"id": "check_transfer_01j8rs605a4gctmbm58d87mvsj",
"amount": 10000,
"status": "issued",
"memo": "Disbursement to nonprofit",
"check_number": "123456789",
"recipient_name": "Charity Good",
"tracking_updates": [
{
"category": "in_transit",
"created_at": "2020-01-31T23:00:00Z"
}
],
"submitted_at": "2020-01-31T23:00:00Z",
"canceled_at": "2020-01-31T23:00:00Z",
"stopped_at": "2020-01-31T23:00:00Z",
"deposited_at": "2020-01-31T23:00:00Z",
"created_at": "2020-01-31T23:00:00Z",
"updated_at": "2020-01-31T23:00:00Z"
}
}
],
"transactions": [
{
"id": "txn_1LaXpKGUcADgqoEMl0Cx0Ygg",
"amount": 10000,
"fee_amount": 500,
"net_amount": 9500,
"description": "Disbursement to nonprofit",
"donor_advised_fund_grant": {
"grant_id": "grant_1234567890",
"organization_name": "Vanguard Charitable",
"fund_name": "John Doe Fund",
"purpose": "General Operating Support",
"note": "This grant is for the general operating support of the organization.",
"donors": [
{
"first_name": "John",
"last_name": "Doe",
"email": "bob@me.com",
"phone": "415-555-1212"
}
]
},
"created_at": "2020-01-31T23:00:00Z",
"updated_at": "2020-01-31T23:00:00Z"
}
]
}