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. <Note title="Sandbox Only" icon="fa-light fa-atom-simple"> This API is only available in the sandbox environment. </Note>

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.

Sandbox Only

This API is only available in the sandbox environment.

Authentication

AuthorizationBearer

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

Path parameters

idstringRequired

The unique identifier for the disbursement

Response

The disbursement failure simulation was accepted

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

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.

Sandbox Only

This API is only available in the sandbox environment.

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

The unique identifier for the disbursement

The disbursement failure simulation was accepted

$	curl -X POST https://api.givechariot.com/v1/simulations/disbursements/disbursement_01jpjen1s23s29kkmnjsb6fzga/fail \
>	-H "Authorization: Bearer <token>"