DisbursementsDisbursements

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.

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

Errors