disbursements
Sandbox: Fail a disbursement
Simulates a payment failure or return for testing purposes. The disbursement must have a status of submitted. This only applies for disbursements sent via ACH or check.
- ACH disbursements: Status becomes failed (payment was returned and cannot be retried)
- Check disbursements: Status becomes validating_organization (check was returned). When this happens, Chariot will investigate why the check failed to reach the organization, update any required recipient information (such as mailing address or organization contact details), and automatically reattempt payout once the issue is resolved.
post/v1/simulations/disbursements/{id}/fail
Request
- Base URLhttps://sandboxapi.givechariot.com
- URLhttps://sandboxapi.givechariot.com/v1/simulations/disbursements/{id}/fail
- AuthHTTP bearer
Path parameters
idstring required
The unique identifier for the disbursement
Response
The disbursement failure simulation was accepted
Changes
No recorded changes to this operation across all 12 revisions of this API.