Funding Bank Account

Let a company replace the bank account Everee debits to fund its payroll.

The funding bank account is the company's bank account that Everee debits to fund its payroll. A company first connects it while onboarding, in the signing experience: it is one of the readiness checks (BANK_ACCOUNT), and onboarding can't be submitted without it.

After onboarding, use the FUNDING_BANK_ACCOUNT component when the company needs to change the account. You never handle the company's bank credentials in either place.

How Everee uses the account

Every account a company connects replaces the one before it. The most recently connected account is the company's current funding account, and Everee stops using the account it replaced.

Everee reads the current account when it needs it, not once at setup:

  • When a payroll run is calculated and approved, Everee checks that the account's available balance covers the funding the run needs. If it doesn't, the run is blocked with an INSUFFICIENT_FUNDS blocker, which Everee rechecks on its own as the balance changes.
  • When you retry a funding, Everee checks the account again. See Funding payroll.

So update the account before you approve the run that should be funded from it.

Creating the session

Create a component session with your company's API token and the x-everee-tenant-id header, and set experience to FUNDING_BANK_ACCOUNT. This is a company-level component, so don't send workerId or externalWorkerId. experienceVersion is optional.

{
  "experience": "FUNDING_BANK_ACCOUNT",
  "eventHandlerName": "everee"
}

The response contains a url. Display it in a web view, then handle the events the component sends. See Handling events.

What the person updating the account does

They connect the new account through their bank, review the funding account agreement that authorizes Everee to debit it, and sign by typing their name. The component then shows a confirmation, or an error screen with a way to try again.

In a sandbox company, the bank step behaves as it does when signing the agreements. See Signing the agreements.

Confirming the change

The component sends a DISMISS event when the person finishes or leaves, and it doesn't distinguish the two. It doesn't send a separate success event. To confirm the account was updated, retrieve the funding bank account, which returns the current account (never the full account number).

Related


Did this page help you?