Testing Payments in Sandbox

In the sandbox environment, payrolls transition to the next phase of payroll processing automatically. Every 5 minutes, an automated job moves payrolls from one phase to the next. To start the process, you just need to create and approve a payroll.

The phases are in the following order:

  • Pending
  • Processing
  • Payments sent

Once payments are sent, any ACH payments are immediately shifted to a terminal status (completed or failed). Wire payments are reconciled and marked as completed every 5 minutes.

📘

How to turn off automatic status transition in Sandbox

If you would like to avoid the automatic payroll status transitions in Sandbox, you can create a company with a trade name of Static Co (spelled exactly, including case sensitivity). Any payrolls created for this company will be skipped by the job that transitions payroll statuses in Sandbox.

Failure Scenarios

We provide a mechanism to incur and cause failed payments in our sandbox environment. Using designated company and employee names, you can simulate payrolls transitioning into a failed payment state.

NSF

To simulate a payroll that fails to due an NSF in sandbox, create a company with a trade_name of NSF Co. or No Account Co.. The initial debit for payrolls on companies matching that trade name will immediately fail with a failure_code of INSUFFICIENT_FUNDS. Any retry attempts will immediately succeed.

Employee Closed Account

To simulate a failed credit due to an ACCOUNT_CLOSED failure in sandbox, create an employee with first_name set to Barry and last_name set to BadAccount. The initial credit payment for payroll items matching that employee name will immediately fail with a failure_code of ACCOUNT_CLOSED. Any retry or refund attempts will immediately succeed.

Company NameEmployee NameResult
NSF Co. or No Account Co.Anything other than Barry BadAccountPayroll debit fails due to INSUFFICIENT_FUNDS, employee credit succeeds
NSF Co. or No Account Co.Barry BadAccountPayroll debit NSF, employee credit fails due to ACCOUNT_CLOSED
Anything other than NSF Co. or No Account Co.Barry BadAccountPayroll debit succeeds, employee credit fails due to ACCOUNT_CLOSED

📘

Testing employee closed account

In order for a payroll item with "Barry BadAccount" to fail, the payroll item will need to have a payment_methodof direct_deposit, since manualpayroll items will always be marked as paid. You will be required to create a bank account for the employee before you can set the payment method to direct_deposit.