Skip to main content

Documentation Index

Fetch the complete documentation index at: https://gusto-preview.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Use this table to see all the current notification types with a brief description on what the messaging will include, the contents of its resource array, what triggers it, whether it is actionable or not, whether it is payroll blocking, and whether it expires.
CategoryTitleMessageResource entity typesTriggerActionableAction ItemPayroll BlockingResolves?Expires?Template Variables
bank_error.company_ach_debit_failureUnblock %{payroll_type} payroll for %{payment_check_date}We were unable to debit sufficient funds from %{company_name}‘s bank account due to the following bank error: %{bank_error} for the %{payroll_type} payroll on %{payment_check_date}. Please update the company bank account details and re-run payroll, so that employees can be paid by direct deposit.entity_type: “Payroll”Due to a bank error, a debit failed to the company’s bank account for the 4-day payrollyesUpdate company bank account details to resolve the provided bank error and re-run payrollnoYes, it resolves after the payroll is re-run and finished processingNo{payroll_type}, {payment_check_date}, {company_name}, {bank_error}
bank_error.compensation_credit_failureUnable to deposit funds to %{beneficiary_name}We were unable to deposit a recent paycheck to %{beneficiary_name}‘s bank account, so these funds of %{amount} will be returned to %{company_name}‘s bank account. Once the funds are received, the payment should be made directly to %{beneficiary_name}.entity_type: “Contractor” or “Employee”Due to a bank error, Gusto was unable to deposit funds to an employee or contractor. Because Gusto is unable to hold these funds legally, we have credited the funds to the company bank account.yesCredited compensation to the company’s bank account should be made directly the contractornoNoNo{beneficiary_name}, {amount}, {company_name}
bank_error.contractor_ach_credit_failureUpdate %{contractor_name}‘s bank account detailsWe were unable to deposit a recent paycheck to %{contractor_name}‘s bank account due to the following bank error: %{bank_error}. After their bank account details are updated, we will attempt to redeposit the funds in the next business day.‘entity_type: “BankAccount”, reference_type: “Contractor”Due to a bank error, Gusto was unable to credit funds to the contractor’s bank accountyesUpdate contractor bank account detailsnoYes, it resolves after the contractor has updated their bank account detailsNo{contractor_name}, {bank_error}
bank_error.contractor_ach_debit_failureFailed to debit funds from %{contractor_name}We were unable to debit funds from %{contractor_name}‘s bank account due to the following bank error: %{bank_error}.entity_type: “BankAccount”, reference_type: “Contractor”Due to a bank error, Gusto was unable to debit funds from a contractor’s bank account. This is usually related to a contractor payment reversal.noN/A - informationalnoNoNo{contractor_name}, {bank_error}
bank_error.employee_ach_credit_failureUpdate %{employee_name}‘s bank account detailsWe were unable to deposit a recent paycheck to %{employee_name}‘s bank account due to the following bank error: %{bank_error}. After their bank account details are updated, we will attempt to redeposit the funds in the next business day.entity_type: “BankAccount”, reference_type: “Employee”Due to a bank error, Gusto was unable to credit funds to the employee’s bank accountyesUpdate employee bank accountnoYes, it resolves after the employee has updated their bank account detailsNo{employee_name}, {bank_error}
bank_error.employee_ach_debit_failureFailed to debit funds from %{employee_name}We were unable to debit funds from %{employee_name}‘s bank account due to the following bank error: %{bank_error}. Please recover these funds directly from %{employee_name}, as we cannot retry the debit.entity_type: “BankAccount”, reference_type: “Employee”Due to a bank error, Gusto was unable to debit funds from the employee’s bank account. This is usually related to a payroll reversal.yesRecover funds directly from the employeenonono{employee_name}, {bank_error}
bank_error.fast_payroll_ach_debit_r01_first_failureUnable to debit sufficient funds for %{payment_check_date} payrollPayroll for %{payment_check_date} processed successfully, but we were unable to debit sufficient funds from the associated bank account. A redebit attempt will be made on %{next_attempt_date}.entity_type: “Payroll”Due to an insufficient funds bank error, Gusto was unable to debit payroll funds from the company bank account. This occurs when a company is on faster payment speed.yesAdd sufficient funds to the company’s bank account. Gusto will attempt another redebit at the end of the business day.nonoyes - It expires at the end of the day, either same day as the notification was created, or the next business day.{payment_check_date}, {next_attempt_date}
bank_error.fast_contractor_payment_ach_debit_r01_first_failureUnable to debit sufficient funds for %{payment_check_date} contractor paymentContractor payment for %{payment_check_date} processed successfully, but we were unable to debit sufficient funds from the associated bank account. A redebit attempt will be made on %{next_attempt_date}.entity_type: “ContractorPayment”Due to an insufficient funds bank error, Gusto was unable to debit contractor payment funds from the company bank account. This occurs when a company is on faster payment speed.yesAdd sufficient funds to the company’s bank account. Gusto will attempt another redebit at the end of the business day.nonoyes - It expires at the end of the day, either same day as the notification was created, or the next business day.{payment_check_date}, {next_attempt_date}
bank_error.reconciliation_payroll_ach_debit_failureUnable to debit funds for %{payment_check_date} reconciliation payrollWe were unable to debit funds from %{company_name}‘s bank account due to the following bank error: %{bank_error} for the reconciliation payroll on %{payment_check_date}. We are unable to retry the debit, so please make the tax payments directly.noneDue to a bank error, Gusto was unable to debit funds from the company bank account for a recent reconciliation payroll.yesContact support to determine what tax payments need to be made to what agenciesnonono{company_name}, {bank_error}, {payment_check_date}
bank_error.company_bank_verification_needs_reviewReview the recent bank verification test transactionsWe completed a bank verification test transaction with company bank account %{bank_account_last_four_digits} but received error %{bank_error}. We updated our records accordingly with the bank account information sent from the financial institution and advise reviewing the changes.entity_type: “BankAccount”A test transaction to the company’s bank account completed but returned an erroryesUpdate company bank account detailsnoyesno{bank_account_last_four_digits}, {bank_error}
bank_error.company_bank_verification_failureUnblock future company transactionsWe attempted a test transaction with company bank account %{bank_account_last_four_digits}. The transaction failed with message %{bank_error}. This critical error will prevent future payments. Please update the company’s bank account details.entity_type: “BankAccount”Due to a bank error, A test transaction to the company’s bank account failedyesUpdate company bank account detailsyesyesno{bank_account_last_four_digits}, {bank_error}
bank_error.company_bank_transaction_needs_reviewReview the recent company transaction detailsWe completed a transaction with company bank account %{bank_account_last_four_digits} but received error %{bank_error}. We updated our records accordingly with the bank account information sent from the financial institution and advise reviewing the changes.entity_type: “BankAccount”A transaction to the company’s bank account completed but returned an erroryesUpdate company bank account detailsnoyesno{bank_account_last_four_digits}, {bank_error}
bank_error.company_bank_transaction_failureUnblock future company transactionsWe attempted a transaction with company bank account %{bank_account_last_four_digits}. The transaction failed with message %{bank_error}. This critical error will prevent future payments. Please update the company’s bank account details.entity_type: “BankAccount”Due to a bank error, A transaction to the company’s bank account failedyesUpdate company bank account detailsyesyesno{bank_account_last_four_digits}, {bank_error}
bank_error.contractor_ach_transaction_needs_reviewReview %{contractor_name}‘s recent bank transaction detailsWe completed a transaction with %{contractor_name}‘s bank account ending in %{bank_account_last_four_digits} but received error %{bank_error}. We updated our records accordingly with the bank account information sent from the financial institution and advise reviewing the changes.entity_type: “BankAccount”, reference_type: “Contractor”A transaction to the contractor’s bank account completed but returned an erroryesUpdate contractor bank account detailsnoyesno{contractor_name}, {bank_account_last_four_digits}, {bank_error}
bank_error.employee_ach_transaction_needs_reviewReview %{employee_name}‘s recent bank transaction detailsWe completed a transaction with %{employee_name}‘s bank account ending in %{bank_account_last_four_digits} but received error %{bank_error}. We updated our records accordingly with the bank account information sent from the financial institution and advise reviewing the changes.entity_type: “BankAccount”, reference_type: “Employee”A transaction to the employee’s bank account completed but returned an erroryesUpdate employee bank account detailsnoyesno{employee_name}, {bank_account_last_four_digits}, {bank_error}
bank_error.continue_instant_verificationPayroll is blocked: Verify bank accountWe’ll use this bank account to pay both employees and taxes. Payroll can’t be run until this is done.noneresolving all pending items for funding methodyesVerify company bank accountyesyesnoNone
bank_error.employee_bank_verification_failureUnblock future employee transactionsWe attempted a bank verification test transaction with %{employee_name}‘s bank account %{bank_account_last_four_digits}. The transaction failed with message %{bank_error}. This critical error will prevent future payments. Please update the employee’s bank account details.entity_type: “BankAccount”, reference_type: “Employee”Failed test bank transaction for employeeyesUpdate employee bank account detailsyesyesno{employee_name}, {bank_account_last_four_digits}, {bank_error}
bank_error.contractor_bank_verification_failureUnblock future contractor transactionsWe attempted a bank verification test transaction with %{contractor_name}‘s bank account %{bank_account_last_four_digits}. The transaction failed with message %{bank_error}. This critical error will prevent future payments. Please update the contractor’s bank account details.entity_type: “BankAccount”, reference_type: “Contractor”Failed test bank transaction for contractoryesUpdate contractor bank account detailsnoyesno{contractor_name}, {bank_account_last_four_digits}, {bank_error}