DisbursementsDisbursements

Approve a disbursement

Approve a 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

Headers

AuthorizationstringRequired

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

Response

The disbursement was approved

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.

descriptionstringOptional

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

created_atdatetimeOptional

The date and time the disbursement was created

updated_atdatetimeOptional

The date and time the disbursement was last updated

statusenumOptional

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
  • pending_submission: The disbursement is awaiting submission to the payment rail
  • submitted: The disbursement has been submitted to the payment rail

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

cancelationobjectOptional

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

approvalobjectOptional

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

rejectionobjectOptional

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

submissionobjectOptional

After a disbursement is submitted, this object contains additional details about the disbursement payment. This is useful if you want to track the disbursement over the specific payment rails/networks.

transactionslist of objectsOptional

The list of transactions for the disbursement

Errors