Contact usLogin
GuidesAPI ReferenceChangelog
GuidesAPI ReferenceChangelog
  • Introduction
    • Overview
    • Authentication
    • Errors
    • Software Development Kits
    • Webhooks and Events
    • Sandbox Simulations
  • Core Resources
  • DAFpay
  • Disbursements
LogoLogo
Contact usLogin
DisbursementsDisbursements

Approve multiple disbursements

POST
/v1/disbursements/approve
POST
/v1/disbursements/approve
1curl -X POST https://api.givechariot.com/v1/disbursements/approve \
2     -H "Authorization: Bearer <token>" \
3     -H "Content-Type: application/json" \
4     -d '{
5  "disbursement_ids": [
6    "disbursement_01jpjen1s23s29kkmnjsb6fzga"
7  ]
8}'
Try it
1{
2  "disbursements": [
3    {
4      "id": "disbursement_01jpjen1s23s29kkmnjsb6fzga",
5      "organization_id": "org_01jpjenf5q6cawy43yxfcrxhct",
6      "amount": 10000,
7      "organization": {
8        "id": "org_01j8rs605a4gctmbm58d87mvsj",
9        "ein": "123456789",
10        "name": "American Red Cross",
11        "parent_organization_id": "org_01j8rs605a4gctmbm58d87mvsk",
12        "mission_statement": "To provide relief to those in need",
13        "web": {
14          "domain": "redcross.org"
15        }
16      },
17      "description": "Disbursement to nonprofit",
18      "auto_fund": false,
19      "created_at": "2020-01-31T23:00:00Z",
20      "updated_at": "2020-01-31T23:00:00Z",
21      "status": "pending_approval",
22      "cancelation": {
23        "canceled_by": "user@example.com",
24        "canceled_at": "2020-01-31T23:00:00Z"
25      },
26      "approval": {
27        "approved_by": "user@example.com",
28        "approved_at": "2020-01-31T23:00:00Z"
29      },
30      "rejection": {
31        "rejected_at": "2020-01-31T23:00:00Z"
32      },
33      "transfers": [
34        {
35          "account_transfer": {
36            "id": "account_transfer_01j8rs605a4gctmbm58d87mvsj",
37            "amount": 10000,
38            "created_at": "2020-01-31T23:00:00Z"
39          },
40          "ach_transfer": {
41            "id": "ach_transfer_01j8rs605a4gctmbm58d87mvsj",
42            "amount": 10000,
43            "status": "initiated",
44            "created_at": "2020-01-31T23:00:00Z",
45            "company_entry_description": "Disbursement to nonprofit",
46            "trace_number": "012345678901234",
47            "effective_date": "2020-01-31T23:00:00Z",
48            "submitted_at": "2020-01-31T23:00:00Z",
49            "settled_at": "2020-07-12T15:00:00Z",
50            "rejected_at": "2020-07-12T15:00:00Z",
51            "returned_at": "2020-07-12T15:00:00Z",
52            "updated_at": "2020-01-31T23:00:00Z"
53          },
54          "check_transfer": {
55            "id": "check_transfer_01j8rs605a4gctmbm58d87mvsj",
56            "amount": 10000,
57            "status": "pending",
58            "memo": "Disbursement to nonprofit",
59            "mailing_address": {
60              "city": "city",
61              "country": "country",
62              "line1": "line1",
63              "postal_code": "postal_code",
64              "state": "state"
65            },
66            "created_at": "2020-01-31T23:00:00Z",
67            "check_number": "123456789",
68            "recipient_name": "Charity Good",
69            "tracking_updates": [
70              {
71                "category": "in_transit",
72                "created_at": "2020-01-31T23:00:00Z"
73              }
74            ],
75            "submitted_at": "2020-01-31T23:00:00Z",
76            "canceled_at": "2020-01-31T23:00:00Z",
77            "stopped_at": "2020-01-31T23:00:00Z",
78            "deposited_at": "2020-01-31T23:00:00Z",
79            "updated_at": "2020-01-31T23:00:00Z"
80          }
81        }
82      ],
83      "transactions": [
84        {
85          "amount": 10000,
86          "type": "donor_advised_fund_grant",
87          "id": "txn_1LaXpKGUcADgqoEMl0Cx0Ygg",
88          "description": "Disbursement to nonprofit",
89          "created_at": "2020-01-31T23:00:00Z",
90          "updated_at": "2020-01-31T23:00:00Z"
91        }
92      ]
93    }
94  ],
95  "count": 5
96}
Approve multiple disbursements in a single request. This is useful for batch approval operations. All disbursements must be in the `pending_approval` state. If any disbursement cannot be approved, the entire request will fail and no disbursements will be approved.
Was this page helpful?
Previous

Cancel a pending disbursement

Next
Built with
Cancel a pending disbursement

Authentication

AuthorizationBearer
Bearer authentication of the form `Bearer <token>`, where token is your auth token.

Request

This endpoint expects an object.
disbursement_idslist of stringsRequired
Array of disbursement IDs to approve

Response

The disbursements were approved
disbursementslist of objects
countinteger
The number of disbursements approved

Errors

The disbursements were approved

Bearer authentication of the form Bearer <token>, where token is your auth token.

Approve multiple disbursements in a single request. This is useful for batch approval operations.

All disbursements must be in the pending_approval state. If any disbursement cannot be approved, the entire request will fail and no disbursements will be approved.