Fail a single payment, which moves from processing to failed. Use it on an employee or contractor credit to test a failed direct deposit. To test a failed employer debit, use [Sandbox] Fail funding instead. Sandbox-only. The payment must have a status of processing.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Only supported in Sandbox. Fails a single payment, which moves from processing to failed. Use it on an employee or contractor credit to test a failed direct deposit.
The payment must have a status of processing. Right after [Sandbox] Start processing, a payroll's payments are draft for a few seconds, so wait until they're processing before calling this endpoint. Find a payroll's payments with List payments.
The payroll stays processing until each of its payments is paid or failed. It then moves to partially_paid if any credit failed. The failed payment has can_retry set to true. A failed credit can only be retried to a new bank account with Retry a payment. See Handling Failed Payments.
To test a failed employer debit, use [Sandbox] Fail funding instead.
We recommend setting the payroll's simulation_mode to manual, so the payroll doesn't advance on its own while you test. See Testing Payments in Sandbox.